NSX Cloud Service Manager API Guide

NSX-T Data Center 2.3.0

Table of Contents

  1. Overview
  2. API Methods
    1. Users and Roles
    2. Api Services
      1. Api Request Batching
      2. Authentication
      3. Task Management
    3. Cloud Service Manager
      1. Accounts Statistics
      2. Aws Accounts
      3. Aws Gateway Amis
      4. Aws Gateways
      5. Aws Key Pairs
      6. Aws Regions
      7. Aws Resources
      8. Aws Vpcs
      9. Azure Accounts
      10. Azure Gateways
      11. Azure Regions
      12. Azure Resources
      13. Azure Vnets
      14. Cloud Service Manager
      15. Nsx Manager Accounts
      16. Proxy Server Profile
      17. Virtual Machines
      18. Vpn
    4. Error Resolver
    5. Licensing
    6. Nsx Component Administration
      1. Appliance
      2. Appliance Management
      3. Backup Restore Management
        1. Backup
        2. Restore
      4. Cluster Management
      5. Nsx Administration
      6. Trust Management
        1. Certificate
        2. Crl
        3. Csr
    7. Telemetryconfig
    8. Troubleshooting And Monitoring
      1. System Logs
    9. Upgrade
      1. Bundle
      2. Bundles
      3. Group
      4. History
      5. Nodes
      6. Plan
      7. Status
      8. Upgradeunits
  3. API Types
  4. API Type Schemas
  5. API Errors


Overview

Introduction

NSX Cloud Service Manager provides a programmatic API to automate management activities. The API follows a resource-oriented Representational State Transfer (REST) architecture, using JSON object encoding. Clients interact with the API using RESTful web service calls over the HTTPS protocol.

Each API method is identified by a request method and URI. Method parameters are specified as key-value pairs appended to the URI. Unless otherwise noted, request and response bodies are encoded using JSON, and must conform to the JSON schema associated with each method. The content type of each request and reply is "application/json" unless otherwise specified. Each request that can be made is documented in the API Methods section. The associated request and response body schemas are documented in the API Schemas section.

Some APIs may be marked as deprecated. This indicates that the functionality provided by the API has been removed or replaced with a different API. The description of the API will indicate what API(s) to call instead.

Some APIs may be marked as experimental. This indicates that the API may be changed or removed without notice in a future NSX Cloud Service Manager release.

It is possible for any request to fail. Errors are reported using standard HTTP response codes. It should be assumed the following errors could be returned by any API method: 301 Moved Permanently, 307 Temporary Redirect, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error, 503 Service Unavailable. Where other errors may be returned, the type of error is indicated in the API method description. All errors are documented in the API Errors section.

Request Authentication

Most API calls require authentication. This API supports HTTP Basic authentication and session-based authentication schemes. Multiple authentication schemes may not be used concurrently.

HTTP Basic Authentication

To authenticate a request using HTTP Basic authentication, the caller's credentials are passed using the 'Authorization' header. The header content should consist of a base64-encoded string containing the username and password separated by a single colon (":") character, as specified in RFC 1945 section 11.1.

For example, to authenticate a request using the default credentials of user admin with password admin, include the following header with the request:

Authorization: Basic YWRtaW46YWRtaW4=

The following cURL command will authenticate to the manager using basic authentication and will issue a GET request for logical ports:

curl -k -u USERNAME:PASSWORD https://MANAGER/api/v1/logical-ports

where:
USERNAME is the user to authenticate as,
PASSWORD is the password to provide, and
MANAGER is the IP address or host name of the NSX manager

For example:

curl -k -u admin:secretPw99 https://192.168.22.32/api/v1/logical-ports

Note: the -k argument instructs cURL to skip verifying the manager's self-signed X.509 certificate.

Session-Based Authentication

Session-based authentication is used by calling the /api/session/create authentication API to manage a session cookie. The session cookie returned in the result of a successful login must be provided in subsequent requests in order to associate those requests with the session.

Session state is local to the server responding to the API request. Idle sessions will automatically time-out, or can be terminated immediately using the POST /api/session/destroy API.

To obtain a session cookie, POST form data to the server using the application/x-ww-form-urlencoded media type, with fields "j_username" and "j_password" containing the username and password separated by an ampersand. Since an ampersand is a UNIX shell metacharacter, you may need to surround the argument with single quotes.

The following cURL command will authenticate to the server, will deposit the session cookie in the file "cookies.txt", and will write all HTTP response headers to the file headers.txt. One of these headers is the X-XSRF-TOKEN header that you will need to provide in subsequent requests.

curl -k -c cookies.txt -D headers.txt -X POST -d 'j_username=USERNAME&j_password=PASSWORD' https://MANAGER/api/session/create

For example:

curl -k -c cookies.txt -D headers.txt -X POST -d 'j_username=admin&j_password=secretPw99' https://192.168.22.32/api/session/create

The manager will respond with the roles and permissions granted to the user, and cURL will deposit the session cookie into the file "cookies.txt".

In subsequent cURL requests, use the -b argument to specify the cookie file. You also need to pass the X-XSRF-TOKEN header that was saved to the headers.txt file, using cURL's -H option:

curl -k -b cookies.txt -H "`grep X-XSRF-TOKEN headers.txt`" https://192.168.22.32/api/v1/logical-ports

When the session expires, the manager will respond with a 403 Forbidden HTTP response, at which point you must obtain a new session cookie and X-XSRF-TOKEN.

Session cookies can be destroyed by using the /api/session/destroy API:

curl -k -b cookies.txt -H "`grep X-XSRF-TOKEN headers.txt`" -X POST https://MANAGER/api/session/destroy

Example Requests and Responses

Example requests and responses are provided for most of the API calls below. Your actual response might differ from the example in the number of fields returned because optional empty fields are not returned when you make an API call.

Restrictions on Certain Fields in a Request

When configuring layer 2 switching, the following fields can contain any character except semicolon (;), vertical bar (|), equal sign (=), comma (,), tilde (~), and the "at" sign (@). They also have a length limitation as specified below:

OpenAPI Specification of NSX Cloud Service Manager API

You can get an OpenAPI specification of the NSX Cloud Service Manager API with one of the following calls:



API Methods

Toggle all tables +

Users and Roles

Associated URIs:

Create registration access token

The privileges of the registration token will be the same as the caller. Request:
Method:
POST
URI Path:
/csmapi/api/v1/aaa/registration-token
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/aaa/registration-token Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RegistrationToken+

Example Response: { "token": "e9112e46-a54a-486f-82bb-043b89228c1b", "roles":[ "network_engineer" ] } Required Permissions: crud Additional Errors:

Get registration access token

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/registration-token/<token>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/registration-token/e9112e46-a54a-486f-82bb-043b89228c1b Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RegistrationToken+

Example Response: { "token": "e9112e46-a54a-486f-82bb-043b89228c1b", "roles": [ "network_engineer" ] } Required Permissions: read Additional Errors:

Delete registration access token

Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/aaa/registration-token/<token>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/aaa/registration-token/e9112e46-a54a-486f-82bb-043b89228c1b Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
n/a

Required Permissions: crud Additional Errors:

Assign roles to User or Group

Request:
Method:
POST
URI Path:
/csmapi/api/v1/aaa/role-bindings
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
RoleBinding+

Example Request: POST https://<nsx-mgr>/api/v1/aaa/role-bindings { "name": "local_admin@System Domain", "type": "remote_user", "roles":[ { "role": "auditor" } ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RoleBinding+

Example Response: { "resource_type": "RoleBinding", "description": "", "id": "7e672b0e-f0bd-48bc-b579-9e6f1b2b3969", "display_name": "local_admin@System Domain", "tags": [], "roles": [ { "role": "auditor" } ], "name": "local_admin@System Domain", "type": "remote_user", "_create_user": "admin", "_create_time": 1493960803006, "_last_modified_user": "admin", "_last_modified_time": 1493960803006, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } Required Permissions: crud Feature: users_role_assignments Additional Errors:

Get all users and groups with their roles

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/role-bindings
Request Headers:
n/a
Query Parameters:
RoleBindingRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/role-bindings?page_size=1 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RoleBindingListResult+

Example Response: { "sort_ascending": true, "sort_by": "id", "result_count": 2, "results": [ { "resource_type": "RoleBinding", "description": "", "id": "0395447b-480a-4091-9075-4070138e0cee", "display_name": "rt-group1", "tags": [], "roles": [ { "role": "auditor" } ], "name": "rt-group1", "type": "remote_group", "_create_user": "admin", "_create_time": 1493963048438, "_last_modified_user": "admin", "_last_modified_time": 1493963048438, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "resource_type": "RoleBinding", "description": "", "id": "7e672b0e-f0bd-48bc-b579-9e6f1b2b3969", "display_name": "local_admin@System Domain", "tags": [], "roles": [ { "role": "enterprise_admin" } ], "name": "local_admin@System Domain", "type": "remote_user", "_create_user": "admin", "_create_time": 1493960803006, "_last_modified_user": "admin", "_last_modified_time": 1493960803006, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 } ] } Required Permissions: read Feature: users_role_assignments Additional Errors:

Update User or Group's roles

Request:
Method:
PUT
URI Path:
/csmapi/api/v1/aaa/role-bindings/<binding-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
RoleBinding+

Example Request: PUT https://<nsx-mgr>/api/v1/aaa/role-bindings/5c669dc6-47a8-4508-3077-6a48f26c5a4g { "name": "local_admin@System Domain", "type": "remote_user", "_revision": 0, "roles":[ { "role": "enterprise_admin" } ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RoleBinding+

Example Response: { "resource_type": "RoleBinding", "description": "", "id": "7e672b0e-f0bd-48bc-b579-9e6f1b2b3969", "display_name": "local_admin@System Domain", "tags": [], "roles": [ { "role": "enterprise_admin" } ], "name": "local_admin@System Domain", "type": "remote_user", "_create_user": "admin", "_create_time": 1493960803006, "_last_modified_user": "admin", "_last_modified_time": 1493960803006, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 } Required Permissions: crud Feature: users_role_assignments Additional Errors:

Get user/group's role information

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/role-bindings/<binding-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/role-bindings/5c669dc6-47a8-4508-3077-6a48f26c5a4g Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RoleBinding+

Example Response: { "resource_type": "RoleBinding", "description": "", "id": "7e672b0e-f0bd-48bc-b579-9e6f1b2b3969", "display_name": "local_admin@System Domain", "tags": [], "roles": [ { "role": "enterprise_admin" } ], "name": "local_admin@System Domain", "type": "remote_user", "_create_user": "admin", "_create_time": 1493960803006, "_last_modified_user": "admin", "_last_modified_time": 1493960803006, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } Required Permissions: read Feature: users_role_assignments Additional Errors:

Delete user/group's roles assignment

Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/aaa/role-bindings/<binding-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/aaa/role-bindings/5c669dc6-47a8-4508-3077-6a48f26c5a4g Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Example Response: 200 OK Required Permissions: crud Feature: users_role_assignments Additional Errors:

Delete all stale role assignments

Request:
Method:
POST
URI Path:
/csmapi/api/v1/aaa/role-bindings?action=delete_stale_bindings
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/aaa/role-bindings?action=delete_stale_bindings Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Example Response: 200 OK Required Permissions: crud Feature: users_role_assignments Additional Errors:

Get information about all roles

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/roles
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/roles Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RoleListResult+

Example Response: { "results": [ { "role": "enterprise_admin" }, { "role": "security_op" }, { "role": "auditor" }, { "role": "security_engineer" }, { "role": "network_op" }, { "role": "network_engineer" } ] } Required Permissions: read Feature: users_configuration Additional Errors:

Get role information

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/roles/<role>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/roles/auditor Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RoleWithFeatures+

Example Response: { "role": "auditor", "features": [ { "feature": "groups_ip_sets", "permission": "read" }, { "feature": "groups_mac_sets", "permission": "read" }, { "feature": "groups_ip_pools", "permission": "read" }, { "feature": "groups", "permission": "read" }, { "feature": "services", "permission": "read" } ] } Required Permissions: read Feature: users_configuration Additional Errors:

Get information about logged-in user. The permissions parameter of the NsxRole has been deprecated.

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/user-info
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/user-info Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UserInfo+

Example Response: { "user_name": "admin", "roles": [ { "role": "enterprise_admin" } ] } Required Permissions: none Feature: users_configuration Additional Errors:

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.

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/vidm/groups
Request Headers:
n/a
Query Parameters:
VidmInfoSearchRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/vidm/groups?search_string=clay_group Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VidmInfoListResult+

Example Response: { "result_count": 3, "results": [ { "name": "[email protected]", "type": "remote_group", "display_name": "[email protected]" }, { "name": "[email protected]", "type": "remote_group", "display_name": "[email protected]" }, { "name": "[email protected]", "type": "remote_group", "display_name": "[email protected]" } ] } Required Permissions: read Feature: users_role_assignments Additional Errors:

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.

Request:
Method:
POST
URI Path:
/csmapi/api/v1/aaa/vidm/search
Request Headers:
n/a
Query Parameters:
VidmInfoSearchRequestParameters+
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/aaa/vidm/search?search_string=John Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VidmInfoListResult+

Example Response: { "result_count": 3, "results": [ { "name": "[email protected]", "type": "remote_user", "display_name": "John Doe" }, { "name": "[email protected]", "type": "remote_user", "display_name": "John Roe" }, { "name": "[email protected]", "type": "remote_group", "display_name": "John's Group" } ] } Required Permissions: read Feature: users_role_assignments Additional Errors:

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.

Request:
Method:
GET
URI Path:
/csmapi/api/v1/aaa/vidm/users
Request Headers:
n/a
Query Parameters:
VidmInfoSearchRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/aaa/vidm/users?search_string=John Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VidmInfoListResult+

Example Response: { "result_count": 2, "results": [ { "name": "[email protected]", "type": "remote_user", "display_name": "John Doe" }, { "name": "[email protected]", "type": "remote_user", "display_name": "John Roe" } ] } Required Permissions: read Feature: users_role_assignments Additional Errors:

Api Services

Api Services: Api Request Batching

Associated URIs:

Register a Collection of API Calls at a Single End Point

Enables you to make multiple API requests using a single request. The batch
API takes in an array of logical HTTP requests represented as JSON arrays.
Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the
portion of the URL after https://<nsx-mgr>/api/), optional headers
array (corresponding to HTTP headers) and an optional body (for POST and PUT
requests). The batch API returns an array of logical HTTP responses
represented as JSON arrays. Each response has a status code, an optional
headers array and an optional body (which is a JSON-encoded string).
Request:
Method:
POST
URI Path:
/csmapi/api/v1/batch
Request Headers:
n/a
Query Parameters:
BatchParameter+
Request Body:
BatchRequest+

Example Request: POST https://<nsx-mgr>/api/v1/batch { "requests":[ { "method":"POST", "uri":"/v1/switching-profiles", "body": { "resource_type": "SpoofGuardSwitchingProfile", "display_name": "spoof-guard-lswitch-bindings", "white_list_providers": ["LSWITCH_BINDINGS"] } }, { "method":"GET", "uri":"/v1/switching-profiles" } ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BatchResponse+

Example Response: { "results": [ { "body": { "revision": 0, "id": "9e6e5375-d7d9-48b4-9118-b1121757f1e3", "display_name": "custom1-qos-switching-profile", "code": 201, "body": { "resource_type": "SpoofGuardSwitchingProfile", "id": "02d866d7-495c-47f4-b945-61a8559219b9", "display_name": "spoof-guard-lswitch-bindings", "white_list_providers": [ "LSWITCH_BINDINGS" ], "_last_modified_time": 1458772318447, "_create_time": 1458772318447, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 0 } }, { "code": 200, "body": { "cursor": "00361b53de57-0313-4f3d-b494-635c58b1d986spoof-guard-lswitch-bindings", "result_count": 4, "results": [ { "_revision": 0, "id": "9e6e5375-d7d9-48b4-9118-b1121757f1e3", "display_name": "custom1-qos-switching-profile", "resource_type": "QosSwitchingProfile", "description": "", "id": "7f39bf67-ccf5-4613-8993-506ec89d893a", "display_name": "TT", "tags": [], "dscp": { "mode": "TRUSTED", "priority": 0 }, "shaper_configuration": [ { "resource_type": "IngressRateShaper", "enabled": false, "average_bandwidth_mbps": 0, "peak_bandwidth_mbps": 0, "burst_size_bytes": 0 }, { "resource_type": "IngressBroadcastRateShaper", "enabled": false, "burst_size_bytes": 0, "peak_bandwidth_kbps": 0, "average_bandwidth_kbps": 0 }, { "resource_type": "EgressRateShaper", "enabled": false, "average_bandwidth_mbps": 0, "peak_bandwidth_mbps": 0, "burst_size_bytes": 0 } ], "class_of_service": 2, "_last_modified_time": 1457999948761, "_create_time": 1457999948761, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_last_modified_user": "admin" }, "code": 201 }, { "body": { "result_count": 9, "results": [ { "resource_type": "IpfixSwitchingProfile", "revision": 0, "id": "cb317635-939b-430a-ae50-005fc4c6ac14", "display_name": "nsx-default-ipfix-global-profile", "enabled": false, "_last_modified_time": 1413324646801, "_create_time": 1413324646801, "_create_user": "system", "_last_modified_user": "system" }, { "resource_type": "QosSwitchingProfile", "revision": 0, "id": "9e6e5375-d7d9-48b4-9118-b1121757f1e3", "display_name": "custom1-qos-switching-profile", "system_defined": false, "dscp": { "priority": 1, "mode": "UNTRUSTED" }, "burst_size": 20, "class_of_service": 1, "peak_bandwidth": 400, "average_bandwidth": 200, "_last_modified_time": 1413349096169, "_create_time": 1413349096169, "_create_user": "admin", "_last_modified_user": "admin" }, { "resource_type": "IpDiscoverySwitchingProfile", "revision": 0, "id": "64814784-7896-3901-9741-badeff705639", "display_name": "nsx-default-ip-discovery-overlay-profile", "system_defined": true, "arp_snooping_enabled": true, "dhcp_snooping_enabled": true, "_last_modified_time": 1413324646789, "_create_time": 1413324646789, "_create_user": "system", "_last_modified_user": "system" }, { "resource_type": "IpDiscoverySwitchingProfile", "revision": 0, "id": "64814874-6987-1093-1479-badeff705639", "display_name": "nsx-default-ip-discovery-vlan-profile", "system_defined": true, "arp_snooping_enabled": false, "dhcp_snooping_enabled": false, "_last_modified_time": 1413324646800, "_create_time": 1413324646800, "_create_user": "system", "_last_modified_user": "system" }, { "resource_type": "QosSwitchingProfile", "revision": 0, "id": "f313290b-eba8-4262-bd93-fab5026e9495", "display_name": "nsx-default-qos-switching-profile", "system_defined": true, "dscp": { "priority": 0, "mode": "TRUSTED" }, "burst_size": 0, "class_of_service": 0, "peak_bandwidth": 0, "average_bandwidth": 0, "_last_modified_time": 1413324646729, "_create_time": 1413324646729, "_create_user": "system", "_last_modified_user": "system" }, { "resource_type": "PortMirroringSwitchingProfile", "revision": 1, "id": "93b4b7e8-f116-415d-a50c-3364611b5d09", "display_name": "nsx-default-port-mirroring-profile", "system_defined": false, "direction": "INGRESS", "_last_modified_time": 1413345541673, "_create_time": 1413324646767, "_create_user": "system", "_last_modified_user": "admin" } ] }, "code": 200 "_revision": 0 }, { "resource_type": "SpoofGuardSwitchingProfile", "id": "ff45644f-9dda-4970-b1e3-30ac11ff0582", "display_name": "spoof-guard-lswitch-bindings", "white_list_providers": [ "LSWITCH_BINDINGS" ], "_last_modified_time": 1458754361177, "_create_time": 1458754361177, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 0 }, { "resource_type": "SpoofGuardSwitchingProfile", "id": "02d866d7-495c-47f4-b945-61a8559219b9", "display_name": "spoof-guard-lswitch-bindings", "white_list_providers": [ "LSWITCH_BINDINGS" ], "_last_modified_time": 1458772318447, "_create_time": 1458772318447, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 0 }, { "resource_type": "SpoofGuardSwitchingProfile", "id": "1b53de57-0313-4f3d-b494-635c58b1d986", "display_name": "spoof-guard-lswitch-bindings", "white_list_providers": [ "LSWITCH_BINDINGS" ], "_last_modified_time": 1458754382102, "_create_time": 1458754382102, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 0 } ] } } Required Permissions: none Additional Errors:

Api Services: Authentication

Associated URIs:

Read node authentication policy configuration

Returns information about the currently configured authentication
policies on the node.
Request:
Method:
GET
URI Path:
/api/v1/node/aaa/auth-policy
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/aaa/auth-policy Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AuthenticationPolicyProperties+

Example Response: { "_schema": "AuthenticationPolicyProperties", "_self": { "href": "/node/aaa/auth-policy", "rel": "self" }, "api_failed_auth_lockout_period": 900, "api_failed_auth_reset_period": 900, "api_max_auth_failures": 5, "cli_failed_auth_lockout_period": 900, "cli_max_auth_failures": 5, "minimum_password_length": 8 } Required Permissions: read Feature: system_administration Additional Errors:

Update node authentication policy configuration

Update the currently configured authentication policy on the node.
If any of api_max_auth_failures, api_failed_auth_reset_period, or
api_failed_auth_lockout_period are modified, the http service is
automatically restarted.
Request:
Method:
PUT
URI Path:
/api/v1/node/aaa/auth-policy
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AuthenticationPolicyProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/aaa/auth-policy { "minimum_password_length": 12 } Successful Response:
Response Code:
202 Accepted
Response Headers:
Content-type: application/json
Response Body:
AuthenticationPolicyProperties+

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AuthenticationPolicyProperties+

Example Response: { "minimum_password_length": 12 } Required Permissions: crud Feature: system_administration Additional Errors:

Api Services: Task Management

Associated URIs:

Get information about all tasks

Request:
Method:
GET
URI Path:
/csmapi/api/v1/tasks
Request Headers:
n/a
Query Parameters:
TaskQueryParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/tasks Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TaskListResult+

Example Response: { "result_count" : 1, "results" : [ { "start_time" : 1478646470253, "async_response_available" : true, "cancelable" : false, "end_time" : 1478646470344, "progress" : 100, "id" : "59c7d6c8-7d64-4f0e-8af5-0b5e92bc3330", "user" : "admin", "status" : "SUCCESS" } ] } Required Permissions: read Additional Errors:

Get information about the specified task

Request:
Method:
GET
URI Path:
/csmapi/api/v1/tasks/<task-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/tasks/ab265781-c826-4da7-9487-48a5c713a481 Successful Response:
Response Code:
200 OK, 303 See Other
Response Headers:
Content-type: application/json
Response Body:
TaskProperties+

Example Response: { "progress" : 100, "id" : "ab265781-c826-4da7-9487-48a5c713a481", "end_time" : 1416959364977, "status" : "success", "async_response_available" : false, "cancelable" : false, "start_time" : 1416959362874 } Required Permissions: read Additional Errors:

Get the response of a task

Request:
Method:
GET
URI Path:
/csmapi/api/v1/tasks/<task-id>/response
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/tasks59c7d6c8-7d64-4f0e-8af5-0b5e92bc3330/response Successful Response:
Response Code:
200 OK, 303 See Other
Response Headers:
Content-type: application/json
Response Body:
object

Example Response: { "cursor" : "", "sort_ascending" : true, "sort_by" : "displayName", "result_count" : 0, "results" : [ ] } Required Permissions: read Additional Errors:

Cloud Service Manager

Cloud Service Manager: Accounts Statistics

Associated URIs:

Returns statistics for all Accounts

Returns statistics aggregated over all accounts managed by CSM.
Request:
Method:
GET
URI Path:
/api/v1/csm/accounts/statistics
Request Headers:
n/a
Query Parameters:
AllAccountsStatisticsRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/accounts/statistics Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AllAccountsStatisticsListResult+

Example Response: { "results": [ { "resource_type": "AWS", "accounts_count": 3, "accounts_status": { "sync_in_progress": 1 }, "instance_stats": { "managed": 63, "unmanaged": 25, "error": 1 }, "vpc_stats": { "managed": 4, "unmanaged": 7 }, "regions_count": 4 }, { "resource_type": "AZURE", "accounts_count": 2, "accounts_status": { "sync_in_progress": 1 }, "instance_stats": { "managed": 42, "unmanaged": 25, "error": 3 }, "vnet_stats": { "managed": 2, "unmanaged": 1 }, "regions_count": 5 } ] } Required Permissions: read Feature: cloud_accounts Additional Errors:

Cloud Service Manager: Aws Accounts

Associated URIs:

Add a AWS account to cloud serivce manager

Request:
Method:
POST
URI Path:
/api/v1/csm/aws/accounts
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AwsAccount+

Example Request: POST https://<nsx-csm>/api/v1/csm/aws/accounts { "display_name": "Account ABC", "cloud_type": "AWS", "cloud_tags_enabled" : true, "tenant_id": "123", "auth_method": "CREDENTIALS", "credentials": { "access_key": "A1B1C1", "secret_key": "a2b2c2", "gateway_role": "test-role" } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsAccount+

Example Response: { "id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "display_name": "Account ABC", "tenant_id": "123", "cloud_type": "AWS", "cloud_tags_enabled" : true, "auth_method": "CREDENTIALS", "credentials": { "gateway_role": "test-role" } "instance_stats": { "managed": 0, "unmanaged": 0, "error": 0 }, "vpc_stats": { "managed": 0, "unmanged": 0 }, "regions_count": 0, "status": { "inventory_sync_status": "IN_PROGRESS", "inventory_sync_state": "SYNCING_AWS_REGIONS" } } Required Permissions: crud Feature: cloud_accounts Additional Errors:

Return a list of all AWS accounts

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/accounts
Request Headers:
n/a
Query Parameters:
AwsAccountsListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/accounts?region_id=us-west-2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsAccountsListResult+

Example Response: { "all_accounts_vpc_stats": { "managed": 2, "unmanaged": 4 }, "all_accounts_instance_stats": { "managed": 12, "unmanaged": 22, "error": 1 } } Required Permissions: read Feature: cloud_accounts Additional Errors:

Delete AWS account information

Request:
Method:
DELETE
URI Path:
/api/v1/csm/aws/accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-csm>/api/v1/csm/aws/accounts/d02af61a-e212-486e-b6c8-10462ccfbad6 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: cloud_accounts Additional Errors:

Update a AWS account information

Request:
Method:
PUT
URI Path:
/api/v1/csm/aws/accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AwsAccount+

Example Request: PUT https://<nsx-csm>/api/v1/csm/aws/accounts/9174ffd1-41b1-42d6-a28d-05c61a0698e2 { "display_name": "New Name", "cloud_type": "AWS" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsAccount+

Example Response: { "id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "display_name": "New Name", "tenant_id": "123", "cloud_type": "AWS", "cloud_tags_enabled" : true, "auth_method": "CREDENTIALS", "credentials": { "gateway_role": "test-role" } "instance_stats": { "managed": 63, "unmanaged": 25, "error": 1 }, "vpc_stats": { "managed": 4, "unmanaged": 7 }, "regions_count": 4, "status": { "inventory_sync_status": "SYNCED", "inventory_sync_state": "NOT_APPLICABLE", "credentials_status": "VALID" } } Required Permissions: crud Feature: cloud_accounts Additional Errors:

Returns the details of the particular AWS account

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/accounts/9174ffd1-41b1-42d6-a28d-05c61a0698e2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsAccount+

Example Response: { "id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "display_name": "Account ABC", "tenant_id": "123", "cloud_type": "AWS", "cloud_tags_enabled" : true, "auth_method": "CREDENTIALS", "credentials": { "gateway_role": "test-role" } "instance_stats": { "managed": 63, "unmanaged": 25, "error": 1 }, "vpc_stats": { "managed": 4, "unmanaged": 7 }, "regions_count": 4, "status": { "inventory_sync_status": "SYNCED", "inventory_sync_state": "NOT_APPLICABLE", "credentials_status": "VALID" } } Required Permissions: read Feature: cloud_accounts Additional Errors:

Return status of the account like credentials validity, inventory synchronization status and inventory synchronization state

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/accounts/<account-id>/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/accounts/ d02af61a-e212-486e-b6c8-10462ccfbad6/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsAccountStatus+

Example Response: { "inventory_sync_status": "IN_PROGRESS", "inventory_sync_state": "SYNCING_AWS_VPCS", "credentials_status": "VALID" } Required Permissions: read Feature: cloud_accounts Additional Errors:

Synchronizes Aws account related inventory like Regions, Vpcs, Instances Status of inventory synchronization can be known from Aws account status api

Request:
Method:
POST
URI Path:
/api/v1/csm/aws/accounts/<account-id>?action=sync_inventory
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-csm>/api/v1/csm/aws/accounts/ d02af61a-e212-486e-b6c8-10462ccfbad6?action=sync_inventory Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: cloud_accounts Additional Errors:

Cloud Service Manager: Aws Gateway Amis

Associated URIs:

DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Returns a list of Aws Gateway Amis. (Deprecated)

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/gateway-amis
Request Headers:
n/a
Query Parameters:
AwsGatewayAmisListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/gateway-amis/ Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayAmisListResult+

Example Response: { "results": [ { "region_id": "us-west-1", "ami_id": "ami-789", "_protection": "NOT_PROTECTED", "_revision": 0 }, { "region_id": "us-west-2", "ami_id": "ami-123", "_protection": "NOT_PROTECTED", "_revision": 0 } ] } Required Permissions: read Feature: ami_region_mapping Additional Errors:

DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Registers a AWS Gateway AMI for the region specified in the body. One can register only one gateway AMI ID per region. If a gateway AMI is already registered with a region, user is expected to use update API to overwrite the registerd AMI for a region. (Deprecated)

Request:
Method:
POST
URI Path:
/api/v1/csm/aws/gateway-amis
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AwsGatewayAmiInfo+

Example Request: POST https://<nsx-csm>/api/v1/csm/aws/gateway-amis { "region_id": "us-west-2", "ami_id": "ami-123" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayAmiInfo+

Example Response: { "region_id": "us-west-2", "ami_id": "ami-123", "_protection": "NOT_PROTECTED", "_revision": 0 } Required Permissions: crud Feature: ami_region_mapping Additional Errors:

DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Delete a AWS Gateway AMI. (Deprecated)

Request:
Method:
DELETE
URI Path:
/api/v1/csm/aws/gateway-amis/<region-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-csm>/api/v1/csm/aws/gateway-amis/us-west-2 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: ami_region_mapping Additional Errors:

DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Returns AWS Gateway AMI for a particular region. (Deprecated)

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/gateway-amis/<region-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/gateway-amis/us-west-2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayAmiInfo+

Example Response: { "region_id": "us-west-2", "ami_id": "ami-123", "_protection": "NOT_PROTECTED", "_revision": 0 } Required Permissions: read Feature: ami_region_mapping Additional Errors:

DEPRECATED. This API is needed only in NSX Cloud as a Service workflow, which is discontinued. Update a AWS Gateway AMI. (Deprecated)

Request:
Method:
PUT
URI Path:
/api/v1/csm/aws/gateway-amis/<region-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AwsGatewayAmiInfo+

Example Request: PUT https://<nsx-csm>/api/v1/csm/aws/gateway-amis/us-west-2 { "region_id": "us-west-2", "ami_id": "ami-456", "_revision": 0 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayAmiInfo+

Example Response: { "region_id": "us-west-2", "ami_id": "ami-123", "_protection": "NOT_PROTECTED", "_revision": 0 } Required Permissions: crud Feature: ami_region_mapping Additional Errors:

Cloud Service Manager: Aws Gateways

Associated URIs:

Returns configuration information for all gateways

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/gateways
Request Headers:
n/a
Query Parameters:
AwsGatewaysListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/gateways Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewaysListResult+

Example Response: { "results": [ { "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "configuration": { "gateway_ha_configuration": [ { "availability_zone": "us-west-2a", "uplink_subnet": "subnet-4b1e122f", "management_subnet": "subnet-ea1e128e", "downlink_subnet": "subnet-041e1260", "gateway_ha_index": 0 } ], "default_quarantine_policy_enabled": false, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "dns_settings": { "dns_mode": "DHCP" }, "nsx_manager_connection": "PUBLIC_IP", "ami_id": "ami-123", "key_pair_name": "test-key", "is_ha_enabled": false }, "vpc_id": "vpc-c35dbaa4" }, { "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "configuration": { "gateway_ha_configuration": [ { "availability_zone": "us-west-1b", "uplink_subnet": "subnet-5b1e124h", "management_subnet": "subnet-a1e128t", "downlink_subnet": "subnet-141e1266", "gateway_ha_index": 0 }, { "availability_zone": "us-west-1a", "uplink_subnet": "subnet-7b1e932d", "management_subnet": "subnet-w1e128h", "downlink_subnet": "subnet-a41e1264", "gateway_ha_index": 0 } ], "default_quarantine_policy_enabled": true, "nsx_manager_connection": "PRIVATE_IP", "ami_id": "ami-456", "key_pair_name": "test-key", "is_ha_enabled": true }, "vpc_id": "vpc-d76nfie6" } ] } Required Permissions: read Feature: gateway_deployment Additional Errors:

Returns configuration for primary gateway and secondary gateway for the vpc,if exists.

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/gateways/<vpc-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/gateways/vpc-1234 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayDeployConfig+

Example Response: { "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "configuration": { "gateway_ha_configuration": [ { "availability_zone": "us-west-2a", "uplink_subnet": "subnet-4b1e122f", "management_subnet": "subnet-ea1e128e", "downlink_subnet": "subnet-041e1260", "gateway_ha_index": 0 } ], "default_quarantine_policy_enabled": false, "proxy_server_profile":"a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PUBLIC_IP", "ami_id": "ami-123", "key_pair_name": "test-key", "is_ha_enabled": false }, "vpc_id": "vpc-c35dbaa4" } Required Permissions: read Feature: gateway_deployment Additional Errors:

Updates configuration for primary gateway and secondary gateway for the vpc, if exists.

Request:
Method:
PUT
URI Path:
/api/v1/csm/aws/gateways/<vpc-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AwsGatewayDeployConfig+

Example Request: PUT https://<nsx-csm>/api/v1/csm/aws/gateways/vpc-1234 { "configuration": { "default_quarantine_policy_enabled": true, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "is_ha_enabled": false }, "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "vpc_id": "vpc-c35dbaa4" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayDeployConfig+

Example Response: { "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "configuration": { "gateway_ha_configuration": [ { "availability_zone": "us-west-2a", "uplink_subnet": "subnet-4b1e122f", "management_subnet": "subnet-ea1e128e", "downlink_subnet": "subnet-041e1260", "gateway_ha_index": 0 } ], "default_quarantine_policy_enabled": true, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "dns_settings": { "dns_mode": "DHCP" }, "nsx_manager_connection": "PUBLIC_IP", "ami_id": "ami-123", "key_pair_name": "test-key", "is_ha_enabled": false }, "vpc_id": "vpc-c35dbaa4" } Required Permissions: crud Feature: quarantine_policy Additional Errors:

Returns status information for primary gateway and secondary gateway for the vpc, if exists.

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/gateways/<vpc-id>/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/gateways/vpc-1234/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayStatus+

Example Response: { "gateway_instances_status": [ { "gateway_status": "DEPLOYING", "gateway_instance_id": "i-176", "gateway_ha_index": 0, "deployment_status": 80, "deployment_state": "CONFIGURING_GATEWAY", "gateway_name": "nsxc-gw-vpc-c35dbaa4-preferred-active" } ] } Required Permissions: read Feature: gateway_deployment Additional Errors:

Deploys gateway for the specified VPC

All the required configuration to deploy AWS gateways will be absorbed
as a part of request body in this API and gateway deployment will be
triggered. Deployment progress can be known from GetAwsGatewayStatus API.
Upon successful deployment of a gateway, the deployment_step will be
DEPLOYMENT_SUCCESSFUL and gateway_status will be UP. If any error is
encountered during deployment, corresponding error_code and error_message
will be populated in gateway_instances_status
Request:
Method:
POST
URI Path:
/api/v1/csm/aws/gateways?action=deploy
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AwsGatewayDeployConfig+

Example Request: POST https://<nsx-csm>/api/v1/csm/aws/gateways?action=deploy { "configuration": { "ami_id": "ami-123", "nsx_manager_connection": "PUBLIC_IP", "default_quarantine_policy_enabled": false, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "key_pair_name": "test-key", "is_ha_enabled": false, "gateway_ha_configuration": [{ "availability_zone": "us-west-2a", "uplink_subnet": "subnet-4b1e122f", "downlink_subnet": "subnet-041e1260", "management_subnet": "subnet-ea1e128e", "gateway_ha_index": 0, "public_ip_settings": { "ip_allocation_mode": "ALLOCATE_NEW", "public_ip": "1.2.3.4" }, "uplink_public_ip_settings" : { "public_ip" : "104.210.53.56", "ip_allocation_mode" : "USE_EXISTING" } }], "dns_settings": { "dns_mode": "DHCP", "dns_list": ["10.162.204.1", "10.166.1.1"] }}, "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "vpc_id": "vpc-c35dbaa4" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayDeployConfig+

Example Response: { "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "configuration": { "gateway_ha_configuration": [ { "availability_zone": "us-west-2a", "uplink_subnet": "subnet-4b1e122f", "management_subnet": "subnet-ea1e128e", "downlink_subnet": "subnet-041e1260", "gateway_ha_index": 0, "public_ip_settings": { "public_ip": "1.2.3.4" }, "uplink_public_ip_settings" : { "public_ip" : "104.210.53.56" } } ], "default_quarantine_policy_enabled": false, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "dns_settings": { "dns_mode": "DHCP", "dns_list": ["10.162.204.1", "10.166.1.1"] }, "nsx_manager_connection": "PUBLIC_IP", "ami_id": "ami-123", "key_pair_name": "test-key", "is_ha_enabled": false }, "vpc_id": "vpc-c35dbaa4" } Required Permissions: crud Feature: gateway_deployment Additional Errors:

Undeploys gateway for the specified VPC

All the required configuration to undeploy AWS gateway will be absorbed
as a part of request body in this API and gateway undeployment will be
triggered. Undeployment progress can be known from GetAwsGatewayStatus
API. Upon successful undeployment of a gateway, the deployment_step will be
UNDEPLOYMENT_SUCCESSFUL and gateway_status will be NOT_AVAILABLE. If any
error is encountered during undeployment, corresponding error_code and
error_message will be populated in gateway_instances_status
Request:
Method:
POST
URI Path:
/api/v1/csm/aws/gateways?action=undeploy
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AwsGatewayUndeployConfig+

Example Request: POST https://<nsx-csm>/api/v1/csm/aws/gateways?action=undeploy { "account_id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "instance_id": "i-0c2ab8e25221bcf7c" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: gateway_deployment Additional Errors:

Cloud Service Manager: Aws Key Pairs

Associated URIs:

Returns a list of Aws Key Pairs

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/key-pairs
Request Headers:
n/a
Query Parameters:
AwsKeyPairListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/key-pairs? account_id=7324800c-a41a-4cb4-b988-51fa3d093397®ion_id=ap-southeast-1 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsKeyPairList+

Example Response: { "results": [ { "name": "test-key-1" }, { "name": "test-key-2" }, { "name": "test-key-3" } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns a list of subnets

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/subnets
Request Headers:
n/a
Query Parameters:
AwsSubnetListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/subnets? account_id=7324800c-a41a-4cb4-b988-51fa3d093397& region_name=us-west-2&vpc_id=vpc-c35dbaa4&availability_zone_name=us-west-2a Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsSubnetListResult+

Example Response: { "results": [ { "display_name": "test-subnet-3", "availability_zone": "us-west-2a", "cidr": "10.0.3.0/24", "id": "subnet-ea1e128e" }, { "display_name": "test-subnet-2", "availability_zone": "us-west-2a", "cidr": "10.0.2.0/24", "id": "subnet-041e1260" }, { "display_name": "test-subnet-1", "availability_zone": "us-west-2a", "cidr": "10.0.1.0/24", "id": "subnet-4b1e122f" } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Aws Regions

Associated URIs:

Returns a list of Aws regions

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/regions
Request Headers:
n/a
Query Parameters:
AwsRegionsListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/regions Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsRegionsListResult+

Example Response: { "cursor": "000214", "sort_ascending": true, "result_count": 2, "results": [ { "id": "us-west-2", "display_name": "us-west-2", "vpc_stats": { "managed": 5, "unmanaged": 7 }, "gateway_stats": { "deploying": 1, "up": 4, "down": 1 }, "availability_zones": [ { "id": "us-west-2a", "display_name": "us-west-2a" }, { "id": "us-west-2b", "display_name": "us-west-2b" }, { "id": "us-west-2c", "display_name": "us-west-2c" } ], "instance_stats": { "managed": 21, "unmanaged": 32, "error": 1 } }, { "id": "ap-south-1", "display_name": "ap-south-1", "vpc_stats": { "managed": 0, "unmanaged": 0 }, "gateway_stats": { "deploying": 0, "up": 0, "down": 0 }, "availability_zones": [ { "id": "ap-south-1b", "display_name": "ap-south-1b" }, { "id": "ap-south-1a", "display_name": "ap-south-1a" } ], "instance_stats": { "managed": 0, "unmanaged": 0, "error": 0 } } } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns information about the particular Aws Region

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/regions/<region-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/regions/us-west-2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsRegion+

Example Response: { "id": "us-west-2", "display_name": "us-west-2", "vpc_stats": { "managed": 5, "unmanaged": 7 }, "gateway_stats": { "deploying": 1, "up": 4, "down": 1 }, "availability_zones": [ { "id": "us-west-2a", "display_name": "us-west-2a" }, { "id": "us-west-2b", "display_name": "us-west-2b" }, { "id": "us-west-2c", "display_name": "us-west-2c" } ], "instance_stats": { "managed": 21, "unmanaged": 32, "error": 1 } } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Aws Resources

Associated URIs:

Returns a list of AWS public IPs

Returns a list of AWS public IPs. These ip addresses are available
to be allocated.
Request:
Method:
GET
URI Path:
/api/v1/csm/aws/public-ips
Request Headers:
n/a
Query Parameters:
AwsResourcesListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/public-ips? account_id=7324800c-a41a-4cb4-b988-51fa3d093397®ion_id=us-west-2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsPublicIpListResult+

Example Response: { "results": [ "104.209.46.64", "104.40.87.204", "40.112.184.178", "13.91.55.98" ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns a list of AWS security groups

Returns a list of AWS security groups.
Request:
Method:
GET
URI Path:
/api/v1/csm/aws/vpcs/security-groups
Request Headers:
n/a
Query Parameters:
AwsSecurityGroupsListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/vpcs/security-groups? account_id=7324800c-a41a-4cb4-b988-51fa3d093397®ion_id=us-west-2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsSecurityGroupsListResult+

Example Response: { "results": [ "default-sg", "quarantine-sg" ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Aws Vpcs

Associated URIs:

Returns a list of Vpcs. Support optional query parameters like account_id, region_id, cidr and/or op_status

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/vpcs
Request Headers:
n/a
Query Parameters:
AwsVpcListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/vpcs Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsVpcListResult+

Example Response: { "cursor": "0003147", "sort_ascending": true, "result_count": 2, "results": [ { "id": "vpc-1", "display_name": "VPC Abc", "is_management_vpc": false, "region_id": "us-east-1", "cidr": "172.31.0.0/16", "instance_stats": { "managed": 0, "unmanaged": 21, "error": 0 }, "op_status": "NSX_UNMANAGED" }, { "id": "vpc-c35dbaa4", "display_name": "VPC Def", "is_management_vpc": true, "transport_zones": [ { "is_underlay_transport_zone": false, "logical_switches": [ { "is_default_logical_switch": false, "instances_count": 0, "nsx_switch_tag": "cd1f2633-e67e-46bd-b546-0dc26a07c56b#8uNQpU1EWLcVjXKHr6ga7axvYBnf2Dwc+I+Js3DEhi4=", "logical_switch_display_name": "DefaultSwitch-Overlay-CSM-vpc-c35dbaa4", "logical_switch_id": "cd1f2633-e67e-46bd-b546-0dc26a07c56b" } ], "transport_zone_id": "d4ccc56a-ab51-4059-b3fb-9af3719b6f51", "transport_zone_display_name": "CSM-vpc-c35dbaa4-Overlay" }, { "is_underlay_transport_zone": true, "logical_switches": [ { "is_default_logical_switch": true, "instances_count": 0, "nsx_switch_tag": "default", "logical_switch_display_name": "DefaultSwitch-VLAN-CSM-vpc-c35dbaa4", "logical_switch_id": "1711f8db-95b8-4df8-bba6-dcac63b08b38" } ], "transport_zone_id": "870fb686-7d42-48c4-9189-8997b4f2df21", "transport_zone_display_name": "CSM-vpc-c35dbaa4-VLAN" } ], "region_id": "us-west-2", "cidr": "10.0.0.0/16", "instance_stats": { "managed": 1, "unmanaged": 4, "error": 0 }, "op_status": "NSX_MANAGED", "gateway_info": { "configuration": { "default_quarantine_policy_enabled": false, "proxy_server_profile":"a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PUBLIC_IP", "ami_id": "ami-649e0b04", "is_ha_enabled": false }, "gateway_status": { "gateway_cluster_id": "b8ab1a4b-3d85-4a84-b92d-eacdc4402528", "gateway_instances_status": [ { "gateway_tn_id": "ef900bfc-1303-11e7-8cf5-021fa9379409", "gateway_node_id": "ef900bfc-1303-11e7-8cf5-021fa9379409", "gateway_status": "UP", "gateway_instance_id": "i-0b62834659a30fc21", "gateway_ha_index": 0, "deployment_state": "DEPLOYMENT_SUCCESSFUL", "gateway_name": "nsx-gw-vpc-c35dbaa4-preferred-active" } ] } } } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns Vpc information

Request:
Method:
GET
URI Path:
/api/v1/csm/aws/vpcs/<vpc-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/aws/vpcs/vpc-ccfe44ab Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsVpc+

Example Response: { "id": "vpc-ccfe44ab", "display_name": "VPC Abc, "is_management_vpc": false, "region_id": "us-west-2", "cidr": "50.0.0.0/16", "instance_stats": { "managed": 0, "unmanaged": 1, "error": 0 }, "op_status": "NSX_UNMANAGED" } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Azure Accounts

Associated URIs:

Returns a list of Azure accounts

Returns a list of Azure accounts with information about each account like
status and statistics. Optional query parameters can be utilized to filter
the list.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/accounts
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/accounts Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureAccountsListResult+

Example Response: { "cursor" : "00011", "sort_ascending" : true, "result_count" : 1, "results" : [ { "id" : "28984eef-d296-4a40-979e", "display_name" : "Account ABC", "tenant_id" : "123", "cloud_type" : "AZURE", "cloud_tags_enabled" : true, "instance_stats" : { "total" : 92, "managed" : 0, "unmanaged" : 82, "error" : 0, "powered_off" : 10 }, "auth_method" : "CREDENTIALS", "credentials" : { "tenant_id" : "123", "subscription_id" : "456", "client_id" : "789", "gateway_role": "NSX role" }, "vnet_stats" : { "managed" : 1, "unmanaged" : 42 }, "regions_count" : 2, "status" : { "inventory_sync_status" : "SYNCED", "credentials_status" : "VALID", "inventory_sync_step" : "NOT_APPLICABLE" }, "has_managed_vnet" : true, "_protection": "NOT_PROTECTED" } ] } Required Permissions: read Feature: cloud_accounts Additional Errors:

Add a Azure account to cloud serivce manager

This api adds a Azure account to cloud service manager. Have to pass
one of the authorization methods in auth_method property as part of
request body followed by appropriate data.
Request:
Method:
POST
URI Path:
/api/v1/csm/azure/accounts
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AzureAccount+

Example Request: POST https://<nsx-csm>/api/v1/csm/azure/accounts { "cloud_type":"AZURE", "regions_count":"", "auth_method":"CREDENTIALS", "display_name": "Account ABC", "credentials":{ "client_id":"789", "key":"012", "subscription_id":"456", "tenant_id":"123", "gateway_role": "NSX role" }, "has_managed_vnet":false, "_revision":0 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureAccount+

Example Response: { "id": "9174ffd1-41b1-42d6-a28d", "display_name": "Account ABC", "tenant_id": "123", "cloud_type": "AZURE", "cloud_tags_enabled": true, "instance_stats": { "total": 92, "managed": 0, "unmanaged": 82, "error": 0, "powered_off": 10 }, "auth_method": "CREDENTIALS", "credentials": { "tenant_id": "123", "subscription_id": "456", "client_id": "789", "gateway_role": "NSX role" }, "vnet_stats": { "managed": 1, "unmanaged": 42 }, "regions_count": 2, "status": { "inventory_sync_status": "IN_PROGRESS", "credentials_status": "VALID", "inventory_sync_step": "SYNCING_VMS" }, "has_managed_vnet": true, "_protection": "NOT_PROTECTED" } Required Permissions: crud Feature: cloud_accounts Additional Errors:

Update a Azure account information

This api updates a Azure account which is added to cloud service manager.
Have to pass one of the authorization methods in auth_method property as part of
request body followed by appropriate data.
Request:
Method:
PUT
URI Path:
/api/v1/csm/azure/accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AzureAccount+

Example Request: PUT https://<nsx-csm>/api/v1/csm/azure/accounts/9174ffd1-41b1-42d6-a28d { "cloud_type":"AZURE", "display_name": "Account XYZ" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureAccount+

Example Response: { "id": "9174ffd1-41b1-42d6-a28d", "display_name": "Account XYZ", "tenant_id": "123", "cloud_type": "AZURE", "cloud_tags_enabled": true, "instance_stats": { "total": 92, "managed": 0, "unmanaged": 82, "error": 0, "powered_off": 10 }, "auth_method": "CREDENTIALS", "credentials": { "tenant_id": "123", "subscription_id": "456", "client_id": "789", "gateway_role": "NSX role" }, "vnet_stats": { "managed": 1, "unmanaged": 42 }, "regions_count": 2, "status": { "inventory_sync_status": "IN_PROGRESS", "credentials_status": "VALID", "inventory_sync_step": "SYNCING_VMS" }, "has_managed_vnet": true, "_protection": "NOT_PROTECTED" } Required Permissions: crud Feature: cloud_accounts Additional Errors:

Returns information about a particular Azure account

Returns information about an Azure account including status and
statistics
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/accounts/9174ffd1-41b1-42d6-a28d Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureAccount+

Example Response: { "id": "9174ffd1-41b1-42d6-a28d", "display_name": "Account ABC", "tenant_id": "123", "cloud_type": "AZURE", "cloud_tags_enabled": true, "instance_stats": { "total": 92, "managed": 0, "unmanaged": 82, "error": 0, "powered_off": 10 }, "auth_method": "CREDENTIALS", "credentials": { "tenant_id": "123", "subscription_id": "456", "client_id": "789", "gateway_role": "NSX role" }, "vnet_stats": { "managed": 1, "unmanaged": 42 }, "regions_count": 2, "status": { "inventory_sync_status": "IN_PROGRESS", "credentials_status": "VALID", "inventory_sync_step": "SYNCING_VMS" }, "has_managed_vnet": true, "_protection": "NOT_PROTECTED" } Required Permissions: read Feature: cloud_accounts Additional Errors:

Delete Azure account information

Deletes Azure account information from cloud service manager Request:
Method:
DELETE
URI Path:
/api/v1/csm/azure/accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-csm>/api/v1/csm/azure/accounts/9174ffd1-41b1-42d6-a28d Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: cloud_accounts Additional Errors:

Returns the status of Azure account

Return status of the account like credentials validity, inventory
synchronization status and inventory synchronization state
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/accounts/<account-id>/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/accounts/9174ffd1-41b1-42d6-a28d/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureAccountStatus+

Example Response: { "inventory_sync_status": "SYNCED", "credentials_status": "VALID", "inventory_sync_step": "NOT_APPLICABLE" } Required Permissions: read Feature: cloud_accounts Additional Errors:

Synchronizes Azure account inventory

Synchronizes Azure account related inventory like Regions, Virtual Networks,
Instances. Status of inventory synchronization can be known from Azure
account status api
Request:
Method:
POST
URI Path:
/api/v1/csm/azure/accounts/<account-id>?action=sync_inventory
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-csm>/api/v1/csm/azure/accounts/9174ffd1-41b1-42d6-a28d?action=sync_inventory Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: cloud_accounts Additional Errors:

Cloud Service Manager: Azure Gateways

Associated URIs:

Returns configuration information for all Azure gateways

Returns a list of Azure gateways with information about each gateway like
subnet configuration and corresponding virtual network. Optional query
parameters can be utilized to filter the list.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/gateways
Request Headers:
n/a
Query Parameters:
AzureGatewaysListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/gateways Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureGatewaysListResult+

Example Response: { "results": [ { "configuration": { "default_quarantine_policy_enabled": false, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PRIVATE_IP", "is_ha_enabled": false, "gateway_ha_configuration": [], "dns_settings": { "dns_mode": "DHCP" }, "ssh_key": "ssh-rsa +SD2/sC/qQXtRj1fVShsolTrLtT5uIRWV3P+4fG2PNR6Wz0/QagHG/+jK8Acw== [email protected]", "image_id": "https://abcxyz.windows.net/public-cloud-gateway/nsx-public-gateway.vhd" }, "vnet_id": "e8e719ff-6a40-48e2-8cf7" } ] } Required Permissions: read Feature: gateway_deployment Additional Errors:

Returns configuration of the Azure gateway

Returns configuration for primary gateway and secondary gateway for the
virtual network, if deployed gateways exist for the specified virtual
network.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/gateways/<vnet-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/gateways/e8e719ff-6a40-48e2-8cf7 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureGatewayDeployConfig+

Example Response: { "account_id": "28984eef-d296-4a40-979e", "configuration": { "default_quarantine_policy_enabled": false, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PRIVATE_IP", "is_ha_enabled": false, "gateway_ha_configuration": [], "dns_settings": { "dns_mode": "DHCP" }, "ssh_key": "ssh-rsa +SD2/sC/qQXtRj1fVShsolTrLtT5uIRWV3P+4fG2PNR6Wz0/QagHG/+jK8Acw== [email protected]", "image_id": "https://abcxyz.windows.net/public-cloud-gateway/nsx-public-gateway.vhd" }, "vnet_id": "e8e719ff-6a40-48e2-8cf7" } Required Permissions: read Feature: gateway_deployment Additional Errors:

Updates Azure gateway configuration

Updates configuration for primary gateway and secondary gateway for the
virutal network, if deployed gateways exist for the specified virtual network.
Request:
Method:
PUT
URI Path:
/api/v1/csm/azure/gateways/<vnet-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AzureGatewayDeployConfig+

Example Request: PUT https://<nsx-csm>/api/v1/csm/azure/gateways/e8e719ff-6a40-48e2-8cf7 { "account_id": "28984eef-d296-4a40-979e", "vnet_id": "e8e719ff-6a40-48e2-8cf7", "configuration": { "default_quarantine_policy_enabled": false, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "auto_agent_install_enabled": false } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureGatewayDeployConfig+

Example Response: { "account_id": "28984eef-d296-4a40-979e", "configuration": { "default_quarantine_policy_enabled": false, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PRIVATE_IP", "is_ha_enabled": false, "gateway_ha_configuration": [], "dns_settings": { "dns_mode": "DHCP" }, "ssh_key": "ssh-rsa +SD2/sC/qQXtRj1fVShsolTrLtT5uIRWV3P+4fG2PNR6Wz0/QagHG/+jK8Acw== [email protected]", "image_id": "https://abcxyz.windows.net/public-cloud-gateway/nsx-public-gateway.vhd", "auto_agent_install_enabled": false }, "vnet_id": "e8e719ff-6a40-48e2-8cf7" } Required Permissions: crud Feature: quarantine_policy Additional Errors:

Return the status of Azure gateway

Returns status information for primary gateway and secondary gateway
for the virtual network, if deployed gateways exist for the specified
virtual network ID.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/gateways/<vnet-id>/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/gateways/e8e719ff-6a40-48e2-8cf7/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureGatewayStatus+

Example Response: { "gateway_cluster_id": "7fe9e2fd-2dce-478f-84b4", "gateway_instances_status": [ { "gateway_tn_id": "1c95f5ea-1eec-11e8-9342", "deployment_step": "DEPLOYMENT_SUCCESSFUL", "public_ip": "1.2.3.4", "gateway_node_id": "1c95f5ea-1eec-11e8-9342", "gateway_status": "UP", "gateway_instance_id": "a61b6dea-46a4-4c09-9ada", "private_ip": "4.3.2.1", "gateway_ha_index": 0, "is_gateway_active": false, "gateway_name": "nsx-gw-customer-gateway" } ] } Required Permissions: read Feature: gateway_deployment Additional Errors:

Deploys gateway for the specified virtual network

All the required configuration to deploy Azure gateways will be absorbed
as a part of request body in this API and gateway deployment will be
triggered. Deployment progress can be known from GetAzureGatewayStatus API.
Upon successful deployment of a gateway, the deployment_step will be
DEPLOYMENT_SUCCESSFUL and gateway_status will be UP. If any error is
encountered during deployment, corresponding error_code and error_message
will be populated in gateway_instances_status
Request:
Method:
POST
URI Path:
/api/v1/csm/azure/gateways?action=deploy
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AzureGatewayDeployConfig+

Example Request: POST https://<nsx-csm>/api/v1/csm/azure/gateways?action=deploy { "account_id": "04e2a29a-90f9-4ce0-ae69", "vnet_id": "e8e719ff-6a40-48e2-8cf7", "configuration": { "image_id": "https://abcxyz.windows.net/public-cloud-gateway/nsx-public-gateway.vhd", "default_quarantine_policy_enabled": true, "proxy_server_profile":"a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PRIVATE_IP", "is_ha_enabled": true, "ssh_key": "ssh-rsa +SD2/sC/qQXtRj1fVShsolTrLtT5uIRWV3P+4fG2PNR6Wz0/QagHG/+jK8Acw== [email protected]", "gateway_ha_configuration": [ { "uplink_subnet": "uplink1", "management_subnet": "Mgmt", "downlink_subnet": "vtep1", "gateway_ha_index": 0, "public_ip_settings": { "ip_allocation_mode": "ALLOCATE_NEW", "public_ip": "1.2.3.4" }, "uplink_public_ip_settings" : { "public_ip" : "104.210.53.56", "ip_allocation_mode" : "USE_EXISTING" } }, { "uplink_subnet": "uplink2", "management_subnet": "Mgmt", "downlink_subnet": "vtep2", "gateway_ha_index": 1, "public_ip_settings": { "ip_allocation_mode": "ALLOCATE_NEW", "public_ip": "4.3.2.1" }, "uplink_public_ip_settings" : { "public_ip" : "104.210.53.56", "ip_allocation_mode" : "USE_EXISTING" } } ], "dns_settings": { "dns_mode": "DHCP", "dns_list": ["10.162.204.1", "10.166.1.1"] } } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureGatewayDeployConfig+

Example Response: { "account_id": "28984eef-d296-4a40-979e", "configuration": { "image_id": "https://abcxyz.windows.net/public-cloud-gateway/nsx-public-gateway.vhd", "default_quarantine_policy_enabled": true, "proxy_server_profile": "a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PRIVATE_IP", "is_ha_enabled": true, "ssh_key": "ssh-rsa +SD2/sC/qQXtRj1fVShsolTrLtT5uIRWV3P+4fG2PNR6Wz0/QagHG/+jK8Acw== [email protected]", "gateway_ha_configuration": [ { "uplink_subnet": "uplink1", "management_subnet": "Mgmt", "downlink_subnet": "vtep1", "gateway_ha_index": 0, "public_ip_settings": { "public_ip": "1.2.3.4" }, "uplink_public_ip_settings" : { "public_ip" : "104.210.53.56" } }, { "uplink_subnet": "uplink2", "management_subnet": "Mgmt", "downlink_subnet": "vtep2", "gateway_ha_index": 1, "public_ip_settings": { "public_ip": "4.3.2.1" }, "uplink_public_ip_settings" : { "public_ip" : "104.210.53.56" } } ], "dns_settings": { "dns_mode": "DHCP", "dns_list": ["10.162.204.1", "10.166.1.1"] } }, "vnet_id": "e8e719ff-6a40-48e2-8cf7" } Required Permissions: crud Feature: gateway_deployment Additional Errors:

Undeploys gateway for the specified virtual network

All the required configuration to undeploy Azure gateway will be absorbed
as a part of request body in this API and gateway undeployment will be
triggered. Undeployment progress can be known from GetAzureGatewayStatus
API. Upon successful undeployment of a gateway, the deployment_step will be
UNDEPLOYMENT_SUCCESSFUL and gateway_status will be NOT_AVAILABLE. If any
error is encountered during undeployment, corresponding error_code and
error_message will be populated in gateway_instances_status
Request:
Method:
POST
URI Path:
/api/v1/csm/azure/gateways?action=undeploy
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AzureGatewayUndeployConfig+

Example Request: POST https://<nsx-csm>/api/v1/csm/azure/gateways?action=undeploy { "account_id": "28984eef-d296-4a40-979e" "instance_id": "a61b6dea-46a4-4c09-9ada" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: gateway_deployment Additional Errors:

Cloud Service Manager: Azure Regions

Associated URIs:

Returns a list of Azure regions

Returns a list of Azure regions with information about each region like
gateway statistics, instance statistics and vnet statistics. Optional query
parameters can be utilized to filter the list.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/regions
Request Headers:
n/a
Query Parameters:
AzureRegionsListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/regions Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureRegionsListResult+

Example Response: { "cursor": "000002", "sort_ascending": true, "result_count": 2, "results": [ { "resource_type": "AzureRegion", "id": "westus", "display_name": "westus", "associated_account_ids": [ "28984eef-d296-4a40-979e" ], "vnet_stats": { "managed": 1, "unmanaged": 10 }, "gateway_stats": { "deploying": 0, "up": 1, "down": 0 }, "instance_stats": { "total": 17, "managed": 0, "unmanaged": 8, "error": 0, "powered_off": 9 }, "has_managed_vnet": true, "_protection": "NOT_PROTECTED" }, { "resource_type": "AzureRegion", "id": "eastus2", "display_name": "eastus2", "associated_account_ids": [], "vnet_stats": { "managed": 0, "unmanaged": 0 }, "gateway_stats": { "deploying": 0, "up": 0, "down": 0 }, "instance_stats": { "total": 0, "managed": 0, "unmanaged": 0, "error": 0, "powered_off": 0 }, "_protection": "NOT_PROTECTED" } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns information about a particular Azure region

Returns information about Azure region like gateway statistics, instance
statistics and vnet statistics.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/regions/<region-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/regions/westus Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureRegion+

Example Response: { "resource_type": "AzureRegion", "id": "westus", "display_name": "westus", "associated_account_ids": [ "28984eef-d296-4a40-979e" ], "vnet_stats": { "managed": 1, "unmanaged": 10 }, "gateway_stats": { "deploying": 0, "up": 1, "down": 0 }, "instance_stats": { "total": 17, "managed": 0, "unmanaged": 8, "error": 0, "powered_off": 9 }, "has_managed_vnet": true, "_protection": "NOT_PROTECTED" } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Azure Resources

Associated URIs:

Returns a list of Azure public IPs

Returns a list of Azure public IPs. These ip addresses are available
to be allocated.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/public-ips
Request Headers:
n/a
Query Parameters:
AzurePublicIpListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/public-ips? account_id=7324800c-a41a-4cb4-b988-51fa3d093397®ion_id=westus Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzurePublicIpListResult+

Example Response: { "results": [ "104.209.46.64", "104.40.87.204", "40.112.184.178", "13.91.55.98" ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns a list of Azure security groups

Returns a list of Azure security groups.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/resource-groups
Request Headers:
n/a
Query Parameters:
AzureResourcesListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/resource-groups? account_id=7324800c-a41a-4cb4-b988-51fa3d093397 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureResourceGroupsListResult+

Example Response: { "results": [ "RG-1", "RG-2" ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns a list of Azure security groups

Returns a list of Azure security groups.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/security-groups
Request Headers:
n/a
Query Parameters:
AzureResourcesListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/security-groups? account_id=7324800c-a41a-4cb4-b988-51fa3d093397®ion_id=us-west-2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureSecurityGroupsListResult+

Example Response: { "results": [ "default-sg", "quarantine-sg" ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns a list of Azure Storage Accounts

Request:
Method:
GET
URI Path:
/api/v1/csm/azure/storage-accounts
Request Headers:
n/a
Query Parameters:
AzureStorageAccountsListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/storage-accounts? account_id=7324800c-a41a-4cb4-b988®ion_id=westus Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureStorageAccountList+

Example Response: { "results": [ { "name": "storage-account-1" }, { "name": "storage-account-2" }, { "name": "storage-account-3" } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns a list of Azure subnets

Returns a list Azure subnets with information about each subnet like ID,
virtual network ID and address space
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/subnets
Request Headers:
n/a
Query Parameters:
AzureSubnetListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/subnets? account_id=7324800c-a41a-4cb4-b988®ion_id=westus&vnet_id=3054a504-4c09-4df7-8420 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureSubnetListResult+

Example Response: { "results": [ { "display_name": "vtep1", "address_space": "172.20.10.0/24", "vnet_id": "3054a504-4c09-4df7-8420", "id": "/subscriptions/1234567890/resourceGroups/NSX-Vnet-3-RG/providers/Microsoft.Network/virtualNetworks/NSX-Vnet-3/subnets/vtep1" }, { "display_name": "vtep2", "address_space": "172.20.11.0/24", "vnet_id": "3054a504-4c09-4df7-8420", "id": "/subscriptions/1234567890/resourceGroups/NSX-Vnet-3-RG/providers/Microsoft.Network/virtualNetworks/NSX-Vnet-3/subnets/vtep2" } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Azure Vnets

Associated URIs:

Returns a list of Azure virtual networks

Returns a list of Azure virtual networks with information about each
virtual network like IPv4 CIDR, gateway information and transport zones.
Optional query parameters can be utilized to filter the list.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/vnets
Request Headers:
n/a
Query Parameters:
AzureVnetListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/vnets Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureVnetListResult+

Example Response: { "cursor": "000002", "sort_ascending": true, "result_count": 2, "results": [ { "resource_type": "AzureVnet", "id": "3054a504-4c09-4df7-8420", "display_name": "NSX-Vnet-1", "cidr_blocks": [ "10.59.1.224/28", "172.20.10.0/24", "172.20.11.0/24", "172.20.12.0/24", "172.20.13.0/24", "172.20.14.0/24" ], "resource_group": "NSX-Vnet-1-RG", "associated_account_ids": [ "28984eef-d296-4a40-979e" ], "region_id": "westus", "resource_id": "/subscriptions/1234567890/resourceGroups/NSX-Vnet-1-RG/providers/Microsoft.Network/virtualNetworks/NSX-Vnet-1", "instance_stats": { "total": 6, "managed": 0, "unmanaged": 5, "error": 0, "powered_off": 1 }, "op_status": "NSX_UNMANAGED", "gateway_info": { "gateway_status": { "gateway_cluster_id": "" } }, "is_management_vnet": false, "_protection": "NOT_PROTECTED" }, { "resource_type": "AzureVnet", "id": "e8e719ff-6a40-48e2-8cf7", "display_name": "NSX-Int-Vnet-Ind-3", "cidr_blocks": [ "10.59.4.112/28", "172.18.35.0/24", "172.18.36.0/24", "172.18.37.0/24", "172.18.38.0/24", "172.18.39.0/24" ], "resource_group": "NSX-Vnet-2-RG", "associated_account_ids": [ "28984eef-d296-4a40-979e" ], "transport_zones": [ { "is_underlay_transport_zone": false, "logical_switches": [ { "is_default_logical_switch": false, "instances_count": 0, "nsx_switch_tag": "a2aad0f1-a48a-474b-8423-41767f538ee0#/E=", "logical_switch_display_name": "DefaultSwitch-Overlay-NSX-Vnet-2", "logical_switch_id": "ls54321" } ], "transport_zone_id": "tz54321", "transport_zone_display_name": "NSX-Vnet-2-Overlay" }, { "is_underlay_transport_zone": true, "logical_switches": [ { "is_default_logical_switch": true, "instances_count": 0, "nsx_switch_tag": "default", "logical_switch_display_name": "DefaultSwitch-VLAN-NSX-Vnet-2", "logical_switch_id": "ls12345" } ], "transport_zone_id": "tz12345", "transport_zone_display_name": "NSX-Vnet-2-VLAN" } ], "region_id": "westus", "resource_id": "/subscriptions/1234567890/resourceGroups/NSX-Vnet-2-RG/providers/Microsoft.Network/virtualNetworks/NSX-Vnet-2", "instance_stats": { "total": 6, "managed": 0, "unmanaged": 6, "error": 0, "powered_off": 0 }, "op_status": "NSX_MANAGED", "gateway_info": { "configuration": { "default_quarantine_policy_enabled": false, "proxy_server_profile":"a491bc83-5fc8-4e05-adb1-af8274422141", "nsx_manager_connection": "PRIVATE_IP", "is_ha_enabled": false, "gateway_ha_configuration": [], "dns_settings": { "dns_mode": "DHCP" }, "ssh_key": "abcxyzabcxyz", "image_id": "https://abcxyz.windows.net/public-cloud-gateway2/nsx-public-gateway.vhd" }, "gateway_status": { "gateway_cluster_id": "abc123", "gateway_instances_status": [ { "gateway_tn_id": "abcde12345", "deployment_step": "DEPLOYMENT_SUCCESSFUL", "public_ip": "1.2.3.4", "gateway_node_id": "12345abcde", "gateway_status": "UP", "gateway_instance_id": "abcde12345", "private_ip": "4.3.2.1", "gateway_ha_index": 0, "is_gateway_active": false, "gateway_name": "nsx-gw-test" } ] } }, "is_management_vnet": false, "_protection": "NOT_PROTECTED" } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns information about a particular Azure virtual network

Returns information about Azure region like virtual network like IPv4 CIDR,
gateway information and transport zones.
Request:
Method:
GET
URI Path:
/api/v1/csm/azure/vnets/<vnet-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/azure/vnets/41e9e760-1c60-4b35-89c2 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AzureVnet+

Example Response: { "resource_type": "AzureVnet", "id": "41e9e760-1c60-4b35-89c2", "display_name": "NSX-Vnet-1", "cidr_blocks": [ "10.59.4.80/28", "172.18.25.0/24", "172.18.26.0/24", "172.18.27.0/24", "172.18.28.0/24", "172.18.29.0/24" ], "resource_group": "NSX-Vnet-1-RG", "associated_account_ids": [ "28984eef-d296-4a40-979e" ], "region_id": "westus", "resource_id": "/subscriptions/1234567890/resourceGroups/NSX-Vnet-1-RG/providers/Microsoft.Network/virtualNetworks/NSX-Vnet-1", "instance_stats": { "total": 1, "managed": 0, "unmanaged": 1, "error": 0, "powered_off": 0 }, "op_status": "NSX_UNMANAGED", "gateway_info": { "gateway_status": { "gateway_cluster_id": "" } }, "is_management_vnet": false, "_protection": "NOT_PROTECTED" } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Cloud Service Manager

Associated URIs:

Return Csm status information

Request:
Method:
GET
URI Path:
/api/v1/csm/csmstatus
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/csmstatus Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CsmStatus+

Example Response: { "id": "a180989d-48fa-4624-af84-d3c7f120d383", "display_name": "CSM Instance", "ip_address": "192.168.122.1", "version": "1.0", "managed_by_vmware": true, "supported_clouds": [ { "cloud_type": "aws" } ] } Required Permissions: read Feature: csm_node_config Additional Errors:

Cloud Service Manager: Nsx Manager Accounts

Associated URIs:

Returns a list of NSX Manager accounts

Request:
Method:
GET
URI Path:
/api/v1/csm/nsx-manager-accounts
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/nsx-manager-accounts Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NsxManagerAccountsListResult+

Example Response: { "results": [ { "id": "a491bc83-5fc8-4e05-adb1-af8274422141", "public_ip": "34.208.244.2", "tenant_id": "345", "thumbprint": "12a76e1ff8d7d6d95ce02dddece11134e402bc436454b7bf4fa61a28418330a1", "username": "admin" } ] } Required Permissions: read Feature: nsx_integration Additional Errors:

Create a NSX Manager account

Request:
Method:
POST
URI Path:
/api/v1/csm/nsx-manager-accounts
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NsxManagerAccount+

Example Request: POST https://<nsx-csm>/api/v1/csm/nsx-manager-accounts { "tenant_id": "345", "public_ip": "34.208.244.2", "thumbprint": "12a76e1ff8d7d6d95ce02dddece11134e402bc436454b7bf4fa61a28418330a1", "username": "admin", "password": "12423dsgfe3" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NsxManagerAccount+

Example Response: { "id": "a491bc83-5fc8-4e05-adb1-af8274422141", "tenant_id": "345", "public_ip": "34.208.244.2", "thumbprint": "12a76e1ff8d7d6d95ce02dddece11134e402bc436454b7bf4fa61a28418330a1", "username": "admin" } Required Permissions: crud Feature: nsx_integration Additional Errors:

Returns the particular NSX Manager account information

Request:
Method:
GET
URI Path:
/api/v1/csm/nsx-manager-accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/nsx-manager-accounts/a491bc83-5fc8-4e05-adb1-af8274422141 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NsxManagerAccount+

Example Response: { "id": "a491bc83-5fc8-4e05-adb1-af8274422141", "public_ip": "34.208.244.2", "tenant_id": "345", "thumbprint": "12a76e1ff8d7d6d95ce02dddece11134e402bc436454b7bf4fa61a28418330a1", "username": "admin" } Required Permissions: read Feature: nsx_integration Additional Errors:

Delete a NSX Manager account

Request:
Method:
DELETE
URI Path:
/api/v1/csm/nsx-manager-accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-csm>/api/v1/csm/nsx-manager-accounts/a491bc83-5fc8-4e05-adb1-af8274422141 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: nsx_integration Additional Errors:

Update a NSX Manager account

Request:
Method:
PUT
URI Path:
/api/v1/csm/nsx-manager-accounts/<account-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NsxManagerAccount+

Example Request: PUT https://<nsx-csm>/api/v1/csm/nsx-manager-accounts/a491bc83-5fc8-4e05-adb1-af8274422141 { "public_ip": "52.1.1.12", "thumbprint": "12a76e1ff8d7d6d95ce02dddece11134e402bc436454b7bf4fa61a28418330a1", "username": "admin", "password": "12423dsgfe3" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NsxManagerAccount+

Example Response: { "id": "a491bc83-5fc8-4e05-adb1-af8274422141", "tenant_id": "123", "public_ip": "52.1.1.12", "thumbprint": "12a76e1ff8d7d6d95ce02dddece11134e402bc436454b7bf4fa61a28418330a1", "username": "New Name" } Required Permissions: crud Feature: nsx_integration Additional Errors:

Cloud Service Manager: Proxy Server Profile

Associated URIs:

Returns a list of Proxy Server Profiles

Request:
Method:
GET
URI Path:
/api/v1/csm/proxy-server-profiles
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/proxy-server-profiles Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ProxyServerProfilesListResult+

Example Response: { "results": [ { "id": "a491bc83-5fc8-4e05-adb1-af8274422141", "profilename": "test" "username": "admin", "host": "1.0.0.0", "port": "3382", "is_default": "true" }, { "id": "b491bc83-5fc8-4e05-tdc1-ef8274422141", "profilename": "proxy-with-certificate", "username": "admin", "host": "2.0.0.0", "port": "3382", "is_default": "true", "tls_certificate":"----BEGIN CERTIFICATE-------" } ] } Required Permissions: read Feature: cloud_accounts Additional Errors:

Create a Proxy Server Profile

Request:
Method:
POST
URI Path:
/api/v1/csm/proxy-server-profiles
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ProxyServerProfileInfo+

Example Request: POST https://<nsx-csm>/api/v1/csm/proxy-server-profiles { "profilename":"test", "username": "admin", "password": "test123", "host": "1.0.0.0", "port": "3382", "is_default":"true" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ProxyServerProfileInfo+

Example Response: { "id": "a491bc83-5fc8-4e05-adb1-af8274422141", "profilename": "test", "username": "admin", "host": "1.0.0.0", "port": "3382", "is_default": "true" } Required Permissions: crud Feature: cloud_accounts Additional Errors:

Returns the particular Proxy Server Profile information

Request:
Method:
GET
URI Path:
/api/v1/csm/proxy-server-profiles/<profile-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/proxy-server-profiles/a491bc83-5fc8-4e05-adb1-af8274422141 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ProxyServerProfileInfo+

Example Response: { "profilename": "test", "username": "admin", "host": "1.0.0.0", "port": "3382", "is_default": "true", "_revision": 0 } Required Permissions: read Feature: cloud_accounts Additional Errors:

Delete a Proxy Server Profile

Request:
Method:
DELETE
URI Path:
/api/v1/csm/proxy-server-profiles/<profile-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-csm>/api/v1/csm/proxy-server_profiles/a491bc83-5fc8-4e05-adb1-af8274422141 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: cloud_accounts Additional Errors:

Update a Proxy Server Profile

Request:
Method:
PUT
URI Path:
/api/v1/csm/proxy-server-profiles/<profile-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ProxyServerProfileInfo+

Example Request: PUT https://<nsx-csm>/api/v1/csm/proxy-server-profiles/a491bc83-5fc8-4e05-adb1-af8274422141 { "profilename": "test", "username": "admin", "password": "test123", "host": "1.0.0.0", "port": "3382", "is_default": "false", "_revision": 0 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ProxyServerProfileInfo+

Example Response: { "id": "a491bc83-5fc8-4e05-adb1-af8274422141", "profilename": "test", "username": "admin", "host": "1.0.0.0", "port": "3382", "is_default": "false", "_revision": 0 } Required Permissions: crud Feature: cloud_accounts Additional Errors:

Cloud Service Manager: Virtual Machines

Associated URIs:

Returns the list of all virtual machines created or imported under a particular account id. Supports optional query parameters like region id, vpc id, public_ip, is_gateway.

Request:
Method:
GET
URI Path:
/api/v1/csm/virtual-machines
Request Headers:
n/a
Query Parameters:
CloudVirtualMachinesListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/virtual-machines Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CloudVirtualMachinesListResult+

Example Response: { "cursor": "0003348", "sort_ascending": true, "result_count": 348, "results": [ { "description": "t2.micro", "id": "i-027c0b32cbe631ec9", "display_name": "vm-2", "is_gateway": false, "private_ip": "13.14.41.253", "cloud_tags": [], "os_type": "AMAZON_LINUX", "agent_status": "NO_AGENT", "os_details": "", "availability_zone": "us-west-2c", "vpc": "vpc-f4ddaf93" }, { "description": "c4.xlarge", "id": "i-0b62834659a30fc21", "display_name": "nsx-gw-vpc-c35dbaa4-preferred-active", "public_ip": "52.89.33.233", "is_gateway": true, "private_ip": "10.0.1.97", "is_gateway_active": true, "cloud_tags": [], "gateway_status": "UP", "os_type": "UBUNTU", "os_details": "LTS 14.04", "availability_zone": "us-west-2a", "vpc": "vpc-c35dbaa4" } ] } Required Permissions: read Feature: cloud_resources Additional Errors:

Returns information about the particular virtual machine

Request:
Method:
GET
URI Path:
/api/v1/csm/virtual-machines/<virtual-machine-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/virtual-machines/i-027c0b32cbe631ec9 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsVirtualMachine+
AzureVirtualMachine+
CloudVirtualMachine+

Example Response: { "description": "t2.micro", "id": "i-027c0b32cbe631ec9", "display_name": "vm-2", "is_gateway": false, "private_ip": "13.14.41.253", "cloud_tags": [], "os_type": "AMAZON_LINUX", "agent_status": "NO_AGENT", "os_details": "", "availability_zone": "us-west-2c", "vpc": "vpc-f4ddaf93" } Required Permissions: read Feature: cloud_resources Additional Errors:

Cloud Service Manager: Vpn

Associated URIs:

Returns the state of the public cloud routing tables from a VPN point of view.

Request:
Method:
GET
URI Path:
/api/v1/csm/vpn/routing-tables/state
Request Headers:
n/a
Query Parameters:
VpnRoutingTablesStateListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-csm>/api/v1/csm/vpn/routing-tables/state Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VpnRoutingTableStateListResult+

Example Response: { "cursor": "0008236", "sort_ascending": true, "result_count": 3, "resource_type": "VpnRoutingTableStateListResult", "results": [ { "id" : "rtb-fa00d882", "managed_for_vpn" : true }, { "id" : "rtb-9f7b06e7", "managed_for_vpn" : false, "reason_for_not_managed" : "RT_CONTAINS_UPLINK_SUBNET" }, { "id" : "rtb-ac08dcd4", "managed_for_vpn" : false, "reason_for_not_managed" : "UNSELECTED" } ], "_last_modified_user": "admin", "_last_modified_time": 1435284879143, "_create_time": 1435284566908, "_create_user": "admin", "_revision": 1 } Required Permissions: read Feature: cloud_resources Additional Errors:

Error Resolver

Associated URIs:

Fetches a list of metadata for all the registered error resolvers

Returns a list of metadata for all the error resolvers registered.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/error-resolver
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/error-resolver Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ErrorResolverInfoList+

Example Response: { "results": [ { "user_metadata": { "user_input_list": [ { "property_value": "1000", "property_name": "connectTimeout", "data_type": "NUMBER" } ] }, "error_id": 1002, "resolver_present": true }, { "user_metadata": {}, "error_id": 1001, "resolver_present": true } ] } Required Permissions: read Additional Errors:

Fetches metadata about the given error_id

Returns some metadata about the given error_id. This includes
information of whether there is a resolver present for the
given error_id and its associated user input data
Request:
Method:
GET
URI Path:
/csmapi/api/v1/error-resolver/<error_id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/error-resolver/1002 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ErrorResolverInfo+

Example Response: { "user_metadata": { "user_input_list": [ { "property_value": "1000", "property_name": "connectTimeout", "data_type": "NUMBER" } ] }, "error_id": 1002, "resolver_present": true } Required Permissions: read Additional Errors:

Resolves the error

Invokes the corresponding error resolver for the
given error(s) present in the payload
Request:
Method:
POST
URI Path:
/csmapi/api/v1/error-resolver?action=resolve_error
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ErrorResolverMetadataList+

Example Request: POST https://<nsx-mgr>/api/v1/error-resolver?action=resolve_error { "errors": [ { "user_metadata": { "user_input_list": [ { "property_value": "default", "property_name": "password", "data_type": "PASSWORD" }, { } ] }, "error_id": 1001, "entity_id": "a123-b234-c355-d3333" } ] } Successful Response:
Response Code:
204 No Content
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Licensing

Associated URIs:

Accept end user license agreement

Accept end user license agreement
Request:
Method:
POST
URI Path:
/csmapi/api/v1/eula/accept
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
n/a

Required Permissions: execute Feature: system_eula Additional Errors:

Return the acceptance status of end user license agreement

Return the acceptance status of end user license agreement
Request:
Method:
GET
URI Path:
/csmapi/api/v1/eula/acceptance
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/eula/acceptance Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
EULAAcceptance+

Example Response: { "acceptance": false } Required Permissions: read Feature: system_eula Additional Errors:

Return the content of end user license agreement

Return the content of end user license agreement in the specified format.
By default, it's pure string without line break
Request:
Method:
GET
URI Path:
/csmapi/api/v1/eula/content
Request Headers:
n/a
Query Parameters:
EULAOutputFormatRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/eula/content?format=html Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
EULAContent+

Example Response: { "content": "End User License Agreement
" } Required Permissions: read Feature: system_eula Additional Errors:

Deprecated. Assign an Updated Enterprise License Key (Deprecated)

Deprecated. Use the POST /licenses API instead
Request:
Method:
PUT
URI Path:
/csmapi/api/v1/license
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
License+

Example Request: PUT https://<nsx-mgr>/api/v1/license { "license_key": "00000-00000-00000-00000-00000" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
License+

Example Response: { "capacity_type": "CPU", "is_expired": false, "quantity": 4, "is_eval": false, "description": "NSX for vSphere - Standard", "expiry": 0, "license_key": "00000-00000-00000-00000-00000" } Required Permissions: crud Feature: system_configuration_license Additional Errors:

Deprecated. Return the Enterprise License (Deprecated)

Deprecated. Use the GET /licenses API instead.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/license
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/license Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
License+

Example Response: { "capacity_type": "VM", "is_expired": false, "quantity": 5, "is_eval": false, "description": "NSX for vSphere - Enterprise", "expiry": 0, "license_key": "00000-00000-00000-00000-00000" } Required Permissions: read Feature: system_configuration_license Additional Errors:

Get all licenses

Returns all licenses.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/licenses
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/licenses Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LicensesListResult+

Example Response: { "result_count": 2, "results": [ { "capacity_type": "VM", "is_expired": false, "quantity": 5, "is_eval": false, "description": "NSX for vSphere - Enterprise", "expiry": 0, "license_key": "00000-00000-00000-00000-00000" }, { "capacity_type": "CPU", "is_expired": false, "quantity": 4, "is_eval": false, "description": "NSX for vSphere - Standard", "expiry": 0, "license_key": "00000-00000-00000-00000-00000" } ] } Required Permissions: read Feature: system_configuration_license Additional Errors:

Add a new license key

This will add a license key to the system.
The API supports adding only one license key for each license edition
type - Standard, Advanced or Enterprise. If a new license key is tried
to add for an edition for which the license key already exists,
then this API will return an error.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/licenses
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
License+

Example Request: POST https://<nsx-mgr>/api/v1/licenses { "license_key": "11111-22222-33333-44444-55555" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
License+

Example Response: { "capacity_type": "VM" "quantity": 1, "is_eval": false, "description" : "NSX for vSphere - Standard" "expiry": 1458688231359, "license_key": "11111-22222-33333-44444-55555" } Required Permissions: crud Feature: system_configuration_license Additional Errors:

Deprecated. Get license properties for license identified by the license-key (Deprecated)

Deprecated. Use GET /licenses API instead. Request:
Method:
GET
URI Path:
/csmapi/api/v1/licenses/<license-key>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/licenses/11111-22222-33333-44444-55555 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
License+

Example Response: { "capacity_type": "VM", "is_expired": false, "quantity": 5, "is_eval": false, "description": "NSX for vSphere - Enterprise", "expiry": 0, "license_key": "11111-22222-33333-44444-55555" } Required Permissions: read Feature: system_configuration_license Additional Errors:

Deprecated. Remove a license identified by the license-key (Deprecated)

Deprecated. Use POST /licenses?action=delete API instead.
Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/licenses/<license-key>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/licenses/11111-22222-33333-44444-55555 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_configuration_license Additional Errors:

Get usage report of all registered modules

Returns usage report of all registered modules
Request:
Method:
GET
URI Path:
/csmapi/api/v1/licenses/licenses-usage
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/licenses/licenses-usage Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FeatureUsageList+

Example Response: { "feature_usage_info": [{ "capacity_usage": [{ "capacity_type": "VM", "usage_count": 10 }, { "capacity_type": "CPU", "usage_count": 10 }], "feature": "VxLAN" }, { "capacity_usage": [{ "capacity_type": "VM", "usage_count": 10 }, { "capacity_type": "CPU", "usage_count": 10 }], "feature": "DFW" }] } Required Permissions: read Feature: system_configuration_license Additional Errors:

Get usage report of all registred modules in CSV format

Returns usage report of all registered modules in CSV format
Request:
Method:
GET
URI Path:
/csmapi/api/v1/licenses/licenses-usage?format=csv
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/licenses/licenses-usage?format=csv Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: text/csv
Response Body:
FeatureUsageListInCsvFormat+

Example Response: feature,vm_usage_count,cpu_usage_count DFW,10,8 VXLAN,10,10 Required Permissions: read Feature: system_configuration_license Additional Errors:

Remove a license

This will delete the license key identified in the request body
by "license_key" and its properties from the system.
Attempting to delete the last license key will result in an error.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/licenses?action=delete
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
License+

Example Request: POST https://<nsx-mgr>/api/v1/licenses?action=delete { "license_key": "11111-22222-33333-44444-55555" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_configuration_license Additional Errors:

Accept end user license agreement

Accept end user license agreement
Request:
Method:
POST
URI Path:
/api/v1/upgrade/eula/accept
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
n/a

Required Permissions: execute Feature: system_eula Additional Errors:

Return the acceptance status of end user license agreement

Return the acceptance status of end user license agreement
Request:
Method:
GET
URI Path:
/api/v1/upgrade/eula/acceptance
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/eula/acceptance Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
EULAAcceptance+

Example Response: { "acceptance": false } Required Permissions: read Feature: system_eula Additional Errors:

Return the content of end user license agreement

Return the content of end user license agreement in the specified format.
By default, it's pure string without line break
Request:
Method:
GET
URI Path:
/api/v1/upgrade/eula/content
Request Headers:
n/a
Query Parameters:
EULAOutputFormatRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/eula/content?format=html Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
EULAContent+

Example Response: { "content": "End User License Agreement
" } Required Permissions: read Feature: system_eula Additional Errors:

Nsx Component Administration

Nsx Component Administration: Appliance

Associated URIs:

NodeMode

Returns current Node Mode.
Request:
Method:
GET
URI Path:
/api/v1/node/mode
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/mode Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeMode+

Example Response: { "mode_id": "VMC" } Required Permissions: read Feature: system_administration Additional Errors:

Nsx Component Administration: Appliance Management

Associated URIs:

Collect audit logs from registered manager nodes

This API is executed on a manager node to display audit logs from all nodes
inside the management plane cluster. An audit log collection will be
triggered if the local master audit log is outdated.
Request:
Method:
POST
URI Path:
/api/v1/administration/audit-logs
Request Headers:
n/a
Query Parameters:
AuditLogQueryParameters+
Request Body:
AuditLogRequest+

Example Request: POST https://<nsx-mgr>/api/v1/administration/audit-logs?page_size=1 { "log_age_limit": 1, "log_filter": "", "log_filter_type": "TEXT" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AuditLogListResult+

Example Response: { "last_full_sync_timestamp": "2017-12-13T19:23:57.042633Z", "cursor": 1457, "result_count": 1, "results": [ { "appname": "NSX", "facility": 22, "full_log": "<182>1 2017-12-11T19:51:39.819Z junjiex-nsxmanager-sb-12479759-1-test7 NSX - SYSTEM [nsx@6876 audit=\"true\" comp=\"nsx-manager\" subcomp=\"manager\"] UserName:'[email protected]', ModuleName:'ACCESS_CONTROL', Operation:'LOGIN', Operation status:'success'", "hostname": "junjiex-nsxmanager-sb-12479759-1-test7", "message": "UserName:'[email protected]', ModuleName:'ACCESS_CONTROL', Operation:'LOGIN', Operation status:'success'", "msgid": "SYSTEM", "priority": 6, "procid": "-", "struct_data": { "audit": "true", "comp": "nsx-manager", "subcomp": "manager" }, "timestamp": "2017-12-11T19:51:39.819Z", "version": "1" } ] } Required Permissions: read Feature: system_log Additional Errors:

Collect support bundles from registered cluster and fabric nodes

Collect support bundles from registered cluster and fabric nodes. Request:
Method:
POST
URI Path:
/api/v1/administration/support-bundles?action=collect
Request Headers:
n/a
Query Parameters:
SupportBundleQueryParameter+
Request Body:
SupportBundleRequest+

Example Request: POST https://<nsx-mgr>/api/v1/administration/support-bundles?action=collect { "nodes": ["d7c33930-964c-42ca-851f-0d15c3c25fe2"] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
SupportBundleResult+

Example Response: Headers Content-Disposition: attachment;filename=nsx_support_archive_20170818_002715.tar Content-Type: application/octet-stream Date: Thu, 18 Aug 2017 00:28:07 GMT Server: NSX Manager Transfer-Encoding: chunked Vmw-Task-Id: 420bbcef-fbde-66b2-8c28-f15bd2b7bc3c_791c820f-6e84-47c7-aa87-b40be387a684 Required Permissions: read Feature: system_support_bundle Additional Errors:

Invoke PUT request on target cluster node

Request:
Method:
PUT
URI Path:
/api/v1/cluster/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Invoke POST request on target cluster node

Request:
Method:
POST
URI Path:
/api/v1/cluster/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Invoke DELETE request on target cluster node

Request:
Method:
DELETE
URI Path:
/api/v1/cluster/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Invoke GET request on target cluster node

Request:
Method:
GET
URI Path:
/api/v1/cluster/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Invoke GET request on target fabric node

Request:
Method:
GET
URI Path:
/api/v1/fabric/nodes/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Invoke PUT request on target fabric node

Request:
Method:
PUT
URI Path:
/api/v1/fabric/nodes/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Invoke DELETE request on target fabric node

Request:
Method:
DELETE
URI Path:
/api/v1/fabric/nodes/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Invoke POST request on target fabric node

Request:
Method:
POST
URI Path:
/api/v1/fabric/nodes/<target-node-id>/<target-uri>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: none Feature: system_administration Additional Errors:

Collect alarms from all NSX nodes (Experimental)

This API is executed on a manager node to return current alarms from all NSX nodes.
Request:
Method:
GET
URI Path:
/api/v1/hpm/alarms
Request Headers:
n/a
Query Parameters:
AlarmQueryParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/hpm/alarms Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AlarmListResult+

Example Response: { "cursor": 0, "result_count": 2, "results": [ { "id": "vmwNSXRoutingBgpNeighborStatus_80956404", "message": "BGP neighbor 00005000-0000-0003-0000-000000000002 with IP 40.40.40.10 status changed to down.", "severity": 3, "source_comp_id": "73fc267f9a7-11e7-a6dd-02004b9e97c4", "source_comp": "nsx-edge", "source_subcomp": "dcsms.msr", "sources": { "id": "00005000-0000-0003-0000-000000000002", "ip_address": "40.40.40.10" }, "state": 1, "timestamp": 1517533690 }, { "id": "vmwNSXPlatformSysDiskUsage_13571574", "message": "Disk usage for varlog partition is 90% for more than 10 minutes", "severity": 3, "source_comp_id": "420af0be-a4e0-caa8-5105-8627fd754a3f", "source_comp": "nsx-manager", "source_subcomp": "node_monitor", "sources": { "mount": "varlog" }, "state": 1, "timestamp": 1517940120 } ] } Required Permissions: read Feature: system_log Additional Errors:

Read node properties

Returns information about the NSX Manager appliance. Information includes
release number, time zone, system time, kernel version, message of the day
(motd), and host name.
Request:
Method:
GET
URI Path:
/api/v1/node
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeProperties+

Example Response: { "cli_timeout": 600, "export_type": "UNRESTRICTED", "hostname": "VMware_NSX_Manager", "kernel_version": "3.14.17-nn1-server", "motd": "", "node_version": "1.0.0.0.0.3063398", "system_time": 1442277320585, "timezone": "Etc/UTC" } Required Permissions: read Feature: system_administration Additional Errors:

Update node properties

Modifies NSX Manager appliance properties. Modifiable properties include the
timezone, message of the day (motd), and hostname. The NSX Manager
node_version, system_time, and kernel_version are read only and cannot be
modified with this method.
Request:
Method:
PUT
URI Path:
/api/v1/node
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node { "motd":"Welcome to the NSX Manager" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeProperties+

Example Response: { "cli_timeout": 600, "hostname": "VMware_NSX_Manager", "kernel_version": "3.14.17-nn1-server", "motd": "Welcome to the NSX Manager", "node_version": "1.0.0.0.0.3063398", "system_time": 1442277530217, "timezone": "Etc/UTC" } Required Permissions: crud Feature: system_administration Additional Errors:

Read AAA provider vIDM properties

Request:
Method:
GET
URI Path:
/api/v1/node/aaa/providers/vidm
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/aaa/providers/vidm Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeAuthProviderVidmProperties+

Example Response: { "vidm_enable": true, "host_name": "jt-vidm.eng.vmware.com", "thumbprint": "898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8", "client_id": "OAuth2Client_NsxClientId", "node_host_name": "jt-nsx.eng.vmware.com" } Required Permissions: read Feature: users_configuration Additional Errors:

Update AAA provider vIDM properties

Request:
Method:
PUT
URI Path:
/api/v1/node/aaa/providers/vidm
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeAuthProviderVidmProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/aaa/providers/vidm { "vidm_enable": true, "host_name": "jt-vidm.eng.vmware.com", "thumbprint": "898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8", "client_id": "OAuth2Client_NsxClientId", "client_secret": "OAuth2Client_NsxClientSecret", "node_host_name": "jt-nsx.eng.vmware.com" } Successful Response:
Response Code:
202 Accepted
Response Headers:
Content-type: application/json
Response Body:
NodeAuthProviderVidmProperties+

Example Response: { "vidm_enable": true, "host_name": "jt-vidm.eng.vmware.com", "thumbprint": "898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8", "client_id": "OAuth2Client_NsxClientId", "node_host_name": "jt-nsx.eng.vmware.com" } Required Permissions: crud Feature: users_configuration Additional Errors:

Read AAA provider vIDM status

Request:
Method:
GET
URI Path:
/api/v1/node/aaa/providers/vidm/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/aaa/providers/vidm/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeAuthProviderVidmStatus+

Example Response: { "vidm_enable": true, "runtime_state": "ALL_OK" } Required Permissions: read Feature: users_configuration Additional Errors:

List node files

Request:
Method:
GET
URI Path:
/api/v1/node/file-store
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/file-store Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FilePropertiesListResult+

Example Response: { "_schema": "FilePropertiesListResult", "_self": "/node/file-store", "result_count": 2, "results": [ { "_schema": "FileProperties", "_self": "/node/file-store/test1.txt", "created_epoch_ms": 1457048893748, "modified_epoch_ms": 1457048860639, "name": "test1.txt", "size": 71 }, { "_schema": "FileProperties", "_self": "/node/file-store/test.txt", "created_epoch_ms": 1457048848624, "modified_epoch_ms": 1457048560936, "name": "test.txt", "size": 50 } ] } Required Permissions: read Feature: system_administration Additional Errors:

Delete file

Request:
Method:
DELETE
URI Path:
/api/v1/node/file-store/<file-name>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Read file properties

Request:
Method:
GET
URI Path:
/api/v1/node/file-store/<file-name>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/file-store/test1.txt Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FileProperties+

Example Response: { "_schema": "FileProperties", "_self": "/node/file-store/test1.txt", "created_epoch_ms": 1457049714901, "modified_epoch_ms": 1457048860639, "name": "test1.txt", "size": 71 } Required Permissions: read Feature: system_administration Additional Errors:

Upload a file to the file store

When you issue this API, the client must specify:
- HTTP header Content-Type:application/octet-stream.
- Request body with the contents of the file in the filestore.
In the CLI, you can view the filestore with the get files command.
Request:
Method:
POST
URI Path:
/api/v1/node/file-store/<file-name>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/file-store/test.txt This is a sentence that is added to the file test.txt. Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
FileProperties+

Example Response: { "_schema": "FileProperties", "_self": "/node/file-store/test.txt", "created_epoch_ms": 1457048560936, "modified_epoch_ms": 1457048560936, "name": "test.txt", "size": 54 } Required Permissions: crud Feature: system_administration Additional Errors:

Read file contents

Request:
Method:
GET
URI Path:
/api/v1/node/file-store/<file-name>/data
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/file-store/test1.txt/data Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/octet-stream
Response Body:
n/a

Example Response: This content can include anything that would be in a text file. Required Permissions: read Feature: system_administration Additional Errors:

Replace file contents

Request:
Method:
PUT
URI Path:
/api/v1/node/file-store/<file-name>/data
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: PUT https://<nsx-mgr>/api/v1/node/file-store/test1.txt/data This is updated content that overwrites the former content. Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FileProperties+

Example Response: { "_schema": "FileProperties", "_self": "/node/file-store/test2.txt", "created_epoch_ms": 1457116797106, "modified_epoch_ms": 1457116797106, "name": "test2.txt", "size": 59 } Required Permissions: crud Feature: system_administration Additional Errors:

Read file thumbprint

Request:
Method:
GET
URI Path:
/api/v1/node/file-store/<file-name>/thumbprint
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/file-store/test1.txt/thumbprint Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FileThumbprint+

Example Response: { "_schema": "FileThumbprint", "_self": "/node/file-store/test1.txt/thumbprint", "name": "test1.txt", "sha1": "ec23cb4208447ce1f81f7cfd4acc9000e20d4949", "sha256": "bda2390dc831e66c4977bc6d16968ed630793031c51e9072297f1e9746b3aca5" } Required Permissions: read Feature: system_administration Additional Errors:

Copy a remote file to the file store

Copy a remote file to the file store. If you use scp or sftp,
you must provide the remote server's SSH fingerprint. See the
NSX-T Administration Guide for information and instructions
about finding the SSH fingerprint.
Request:
Method:
POST
URI Path:
/api/v1/node/file-store/<file-name>?action=copy_from_remote_file
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CopyFromRemoteFileProperties+

Example Request: POST https://<nsx-mgr>/api/v1/node/file-store/file.txt?action=copy_from_remote_file { "port" : 22, "server": "192.168.120.151", "uri" : "/tmp/file.txt", "protocol" : { "name" : "scp", "ssh_fingerprint" : "b5:08:df:c6:55:62:e4:6e:95:70:7c:25:ba:f2:46:f1", "authentication_scheme" : { "scheme_name" : "password", "username" : "root", "password" : "s4druMuJEw" } } } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
FileProperties+

Example Response: { "_schema": "FileProperties", "_self": "/node/file-store/file.txt", "created_epoch_ms": 1459401409964, "modified_epoch_ms": 1459401409748, "name": "file.txt", "size": 19 } Required Permissions: crud Feature: system_administration Additional Errors:

Copy file in the file store to a remote file store

Copy a file in the file store to a remote server. If you use scp or
sftp, you must provide the remote server's SSH fingerprint. See the
NSX-T Administration Guide for information and instructions
about finding the SSH fingerprint.
Request:
Method:
POST
URI Path:
/api/v1/node/file-store/<file-name>?action=copy_to_remote_file
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CopyToRemoteFileProperties+

Example Request: POST https://<nsx-mgr>/api/v1/node/file-store/supportbundle.tgz?action=copy_to_remote_file { "port" : 22, "server": "192.168.120.151", "uri" : "/tmp/supportbundle.tgz", "protocol" : { "name" : "scp", "ssh_fingerprint" : "b5:08:df:c6:55:62:e4:6e:95:70:7c:25:ba:f2:46:f1" , "authentication_scheme" : { "scheme_name" : "password", "username" : "root" , "password" : "s4druMuJEw" } } } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: read Feature: system_administration Additional Errors:

Create directory in remote file server

Create a directory on the remote remote server. Supports only SFTP.
You must provide the remote server's SSH fingerprint. See the
NSX Administration Guide for information and instructions
about finding the SSH fingerprint.
Request:
Method:
POST
URI Path:
/api/v1/node/file-store?action=create_remote_directory
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CreateRemoteDirectoryProperties+

Example Request: POST https://<nsx-mgr>/api/v1/node/file-store?action=create_remote_directory { "port" : 22, "server": "192.168.120.151", "uri" : "/tmp/folder", "protocol" : { "name" : "sftp", "ssh_fingerprint" : "b5:08:df:c6:55:62:e4:6e:95:70:7c:25:ba:f2:46:f1" , "authentication_scheme" : { "scheme_name" : "password", "username" : "root" , "password" : "s4druMuJEw" } } } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: read Feature: system_administration Additional Errors:

Enable or disable Mandatory Access Control

Request:
Method:
PUT
URI Path:
/api/v1/node/hardening-policy/mandatory-access-control
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
MandatoryAccessControlProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/hardening-policy/mandatory-access-control -d '{"enabled": true}' Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
MandatoryAccessControlProperties+

Example Response: { "enabled": true, "status": "ENABLED_PENDING_REBOOT" } Required Permissions: crud Feature: system_administration Additional Errors:

Gets the enable status for Mandatory Access Control

Request:
Method:
GET
URI Path:
/api/v1/node/hardening-policy/mandatory-access-control
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/hardening-policy/mandatory-access-control Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
MandatoryAccessControlProperties+

Example Response: { "status": "ENABLED" } Required Permissions: read Feature: system_administration Additional Errors:

Get the report for Mandatory Access Control

Request:
Method:
GET
URI Path:
/api/v1/node/hardening-policy/mandatory-access-control/report
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/hardening-policy/mandatory-access-control/report > mac.tar.gz Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/octet-stream
Response Body:
n/a

Required Permissions: read Feature: system_administration Additional Errors:

Read network configuration properties

Request:
Method:
GET
URI Path:
/api/v1/node/network
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNetworkProperties+

Example Response: { "_schema": "NodeNetworkProperties", "_self": { "href": "/node/network", "rel": "self" } } Required Permissions: read Feature: system_administration Additional Errors:

List the NSX Manager's Network Interfaces

Returns the number of interfaces on the NSX Manager appliance and detailed
information about each interface. Interface information includes MTU,
broadcast and host IP addresses, link and admin status, MAC address, network
mask, and the IP configuration method (static or DHCP).
Request:
Method:
GET
URI Path:
/api/v1/node/network/interfaces
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network/interfaces Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNetworkInterfacePropertiesListResult+

Example Response: { "result_count": 2, "results": [ { "admin_status": "up", "interface_id": "lo", "ip_addresses": [ { "ip_address": "127.0.0.1", "netmask": "255.0.0.0" } ], "link_status": "up", "mtu": 65536, }, { "admin_status": "up", "broadcast_address": "10.160.31.255", "default_gateway": "10.160.31.253", "interface_id": "eth0", "ip_addresses": [ { "ip_address": "10.160.30.117", "netmask": "255.255.224.0" } ], "ip_configuration": "static", "link_status": "up", "mtu": 1500, "physical_address": "02:00:16:60:c7:8f" } ] } Required Permissions: read Feature: system_administration Additional Errors:

Update the NSX Manager's Network Interface

Updates the specified interface properties. You cannot change
the properties ip_configuration,
ip_addresses, or plane. NSX
Manager must have a static IP address.
You must use NSX CLI to configure a controller or an edge node.
Request:
Method:
PUT
URI Path:
/api/v1/node/network/interfaces/<interface-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeNetworkInterfaceProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/network/interfaces/eth0 { "interface_id": "eth0", "mtu": 1600 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNetworkInterfaceProperties+

Example Response: { "admin_status": "up", "broadcast_address": "10.160.31.255", "default_gateway": "10.160.31.253", "interface_id": "eth0", "ip_addresses": [ { "ip_address": "10.160.30.117", "netmask": "255.255.224.0" } ], "ip_configuration": "static", "link_status": "up", "mtu": 1600, "physical_address": "02:00:16:60:c7:8f" } Required Permissions: crud Feature: system_administration Additional Errors:

Read the NSX Manager's Network Interface

Returns detailed information about the specified interface. Interface
information includes MTU, broadcast and host IP addresses, link and admin
status, MAC address, network mask, and the IP configuration method.
Request:
Method:
GET
URI Path:
/api/v1/node/network/interfaces/<interface-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network/interfaces/eth0 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNetworkInterfaceProperties+

Example Response: { "admin_status": "up", "broadcast_address": "10.160.31.255", "default_gateway": "10.160.31.253", "interface_id": "eth0", "ip_addresses": [ { "ip_address": "10.160.30.117", "netmask": "255.255.224.0" } ], "ip_configuration": "static", "link_status": "up", "mtu": 1500, "physical_address": "02:00:16:60:c7:8f" } Required Permissions: read Feature: system_administration Additional Errors:

Read the NSX Manager's Network Interface Statistics

On the specified interface, returns the number of received (rx), transmitted
(tx), and dropped packets; the number of bytes and errors received and
transmitted on the interface; and the number of detected collisions.
Request:
Method:
GET
URI Path:
/api/v1/node/network/interfaces/<interface-id>/stats
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network/interfaces/eth0/stats Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeInterfaceStatisticsProperties+

Example Response: { "interface_id": "eth0", "rx_bytes": 7360718 "rx_dropped": 1813, "rx_errors": 0, "rx_frame": 0, "rx_packets": 91656, "tx_bytes": 31611, "tx_carrier": 0, "tx_colls": 0, "tx_dropped": 0, "tx_errors": 0, "tx_packets": 261, } Required Permissions: read Feature: system_administration Additional Errors:

Update the NSX Manager's Name Servers

Modifies the list of servers that the NSX Manager node uses to look up IP
addresses associated with given domain names. If DHCP is configured, this
method returns a 409 CONFLICT error, because DHCP manages the list of name
servers.
Request:
Method:
PUT
URI Path:
/api/v1/node/network/name-servers
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeNameServersProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/network/name-servers { "name_servers": [ "10.33.38.1", "10.33.38.2", "10.33.38.3" ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNameServersProperties+

Example Response: { "name_servers": [ "10.33.38.1", "10.33.38.2", "10.33.38.3" ] } Required Permissions: crud Feature: system_administration Additional Errors:

Read the NSX Manager's Name Servers

Returns the list of servers that the NSX Manager node uses to look up IP
addresses associated with given domain names.
Request:
Method:
GET
URI Path:
/api/v1/node/network/name-servers
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network/name-servers Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNameServersProperties+

Example Response: { "name_servers": [ "10.33.38.1", "10.33.38.2" ] } Required Permissions: read Feature: system_administration Additional Errors:

Create node network route

Add a route to the NSX Manager routing table. For static routes, the
route_type, interface_id, netmask, and destination are required parameters.
For default routes, the route_type, gateway address, and interface_id
are required. For blackhole routes, the route_type and destination are
required. All other parameters are optional. When you add a static route,
the scope and route_id are created automatically. When you add a default or
blackhole route, the route_id is created automatically. The route_id is
read-only, meaning that it cannot be modified. All other properties can be
modified by deleting and readding the route.
Request:
Method:
POST
URI Path:
/api/v1/node/network/routes
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeRouteProperties+

Example Request: POST https://<nsx-mgr>/api/v1/node/network/routes { "route_type": "static", "interface_id": "eth0", "netmask": "255.255.255.0", "destination": "10.33.85.0" } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
NodeRouteProperties+

Example Response: { "destination": "10.33.85.0" "interface_id": "eth0", "netmask": "255.255.255.0", "route_id": "static-10.33.85.0-eth0-0", "route_type": "static", "scope": "link", } Required Permissions: crud Feature: system_administration Additional Errors:

List node network routes

Returns detailed information about each route in the NSX Manager routing
table. Route information includes the route type (default, static, and so
on), a unique route identifier, the route metric, the protocol from which
the route was learned, the route source (which is the preferred egress
interface), the route destination, and the route scope. The route scope
refers to the distance to the destination network: The "host" scope leads to
a destination address on the NSX Manager, such as a loopback address;
the "link" scope leads to a destination on the local network; and the
"global" scope leads to addresses that are more than one hop away.
Request:
Method:
GET
URI Path:
/api/v1/node/network/routes
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network/routes Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeRoutePropertiesListResult+

Example Response: { "result_count": 2, "results": [ { "gateway": "10.33.87.253", "interface_id": "eth0" "route_id": "default-10.33.87.253-eth0-0", "route_type": "default", }, { "destination": "10.33.84.0" "interface_id": "eth0", "netmask": "255.255.252.0", "proto": "kernel", "route_id": "static-10.33.84.0-eth0-0", "route_type": "static", "scope": "link", "src": "10.33.87.207", } ] } Required Permissions: read Feature: system_administration Additional Errors:

Read node network route

Returns detailed information about a specified route in the NSX Manager
routing table.
Request:
Method:
GET
URI Path:
/api/v1/node/network/routes/<route-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network/routes/default-10.33.87.253-eth0-0 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeRouteProperties+

Example Response: { "gateway": "10.33.87.253", "interface_id": "eth0" "route_id": "default-10.33.87.253-eth0-0", "route_type": "default", } Required Permissions: read Feature: system_administration Additional Errors:

Delete node network route

Delete a route from the NSX Manager routing table. You can modify an
existing route by deleting it and then posting the modified version of the
route. To verify, remove the route ID from the URI, issue a GET request, and
note the absense of the deleted route.
Request:
Method:
DELETE
URI Path:
/api/v1/node/network/routes/<route-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/node/network/routes/static-10.33.85.0-eth0-0 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Update the NSX Manager's Search Domains

Modifies the list of domain names that the NSX Manager node uses to complete
unqualified host names. If DHCP is configured, this method returns
a 409 CONFLICT error, because DHCP manages the list of name servers.
Request:
Method:
PUT
URI Path:
/api/v1/node/network/search-domains
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeSearchDomainsProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/network/search-domains { "search_domains": [ "eng.company.com", "company.com", "eng-backup.company.com" ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSearchDomainsProperties+

Example Response: { "search_domains": [ "eng.company.com", "company.com" "eng-backup.company.com" ] } Required Permissions: crud Feature: system_administration Additional Errors:

Read the NSX Manager's Search Domains

Returns the domain list that the NSX Manager node uses to complete
unqualified host names. When a host name does not include a fully
qualified domain name (FQDN), the NSX Management node appends the
first-listed domain name to the host name before the host name is looked
up. The NSX Management node continues this for each entry in the domain
list until it finds a match.
Request:
Method:
GET
URI Path:
/api/v1/node/network/search-domains
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/network/search-domains Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSearchDomainsProperties+

Example Response: { "search_domains": [ "eng.company.com", "company.com" ] } Required Permissions: read Feature: system_administration Additional Errors:

List node processes

Returns the number of processes and information about each
process. Process information includes 1) mem_resident, which is roughly
equivalent to the amount of RAM, in bytes, currently used by the process,
2) parent process ID (ppid), 3) process name, 4) process up time in milliseconds,
5) mem_used, wich is the amount of virtual memory used by the process, in
bytes, 6) process start time, in milliseconds since epoch, 7) process ID
(pid), 8) CPU time, both user and the system, consumed by the process in
milliseconds.
Request:
Method:
GET
URI Path:
/api/v1/node/processes
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/processes Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeProcessPropertiesListResult+

Example Response: { "result_count": 80, "results": [ { "cpu_time": 800, "mem_resident": 593920, "mem_used": 1871872, "pid": 1, "ppid": 0, "process_name": "init", "start_time": 1412624269865, "uptime": 279760 }, ...[content omitted for brevity] ] } Required Permissions: read Feature: system_administration Additional Errors:

Read node process

Returns information for a specified process ID (pid). Request:
Method:
GET
URI Path:
/api/v1/node/processes/<process-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/processes/1 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeProcessProperties+

Example Response: { "cpu_time": 800, "mem_resident": 593920, "mem_used": 1871872, "pid": 1, "ppid": 0, "process_name": "init", "start_time": 1412624269865, "uptime": 279760 } Required Permissions: read Feature: system_administration Additional Errors:

Check if RabbitMQ management port is enabled or not

Returns status as true if RabbitMQ management port is enabled else false Request:
Method:
GET
URI Path:
/api/v1/node/rabbitmq-management-port
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/rabbitmq-management-port Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PortStatus+

Example Response: { "enabled": false } Required Permissions: read Feature: system_administration Additional Errors:

Delete RabbitMQ management port

Request:
Method:
DELETE
URI Path:
/api/v1/node/rabbitmq-management-port
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/node/rabbitmq-management-port Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Set RabbitMQ management port

Request:
Method:
POST
URI Path:
/api/v1/node/rabbitmq-management-port
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/rabbitmq-management-port Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

List node services

Returns a list of all services available on the NSX Manager applicance.
Request:
Method:
GET
URI Path:
/api/v1/node/services
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServicePropertiesListResult+

Example Response: { "result_count": 5, "results": [ { "service_name": "snmp" }, { "service_name": "syslog" }, { "service_name": "ntp" }, { "service_name": "ssh" }, { "service_name": "node-mgmt" } ] } Required Permissions: read Feature: system_administration Additional Errors:

Read cluster boot manager service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/cluster_manager
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Read cluster boot manager service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/cluster_manager/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the cluster boot manager service

Request:
Method:
POST
URI Path:
/api/v1/node/services/cluster_manager?action=start|stop|restart
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read cm inventory service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/cm-inventory
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/cm-inventory Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Example Response: { "_schema": "NodeCminventoryServiceProperties", "_self": "/node/services/cm-inventory", "service_name": "cm-inventory" } Required Permissions: read Feature: system_administration Additional Errors:

Read manager service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/cm-inventory/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/cm-inventory/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": { "href": "/node/services/cm-inventory/status", "rel": "self" }, "monitor_pid": 1145, "monitor_runtime_state": "running", "pids": [ 1147 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the manager service

Request:
Method:
POST
URI Path:
/api/v1/node/services/cm-inventory?action=start|stop|restart
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/cm-inventory?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read http service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/http
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/http Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeHttpServiceProperties+

Example Response: { "_schema": "NodeHttpServiceProperties", "_self": { "href": "/node/services/http", "rel": "self" }, "service_name": "http", "service_properties": { "certificate": { "pem_encoded": "-BEGIN CERTIFICATE--END CERTIFICATE-\n" }, "cipher_suites": [ { "enabled": true, "name": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" }, { "enabled": false, "name": "TLS_RSA_WITH_AES_256_GCM_SHA384" }, { "enabled": true, "name": "TLS_RSA_WITH_AES_256_CBC_SHA" } ], "connection_timeout": 30000, "protocol_versions": [ { "enabled": true, "name": "TLSv1.1" }, { "enabled": true, "name": "TLSv1.2" } ], "redirect_host": "10.0.0.1", "session_timeout": 1800 } } Required Permissions: read Feature: system_administration Additional Errors:

Update http service properties

Request:
Method:
PUT
URI Path:
/api/v1/node/services/http
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeHttpServiceProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/services/http { "service_name": "http", "service_properties": { "certificate": { "pem_encoded": "-BEGIN CERTIFICATE--END CERTIFICATE-\n" }, "cipher_suites": [ { "enabled": true, "name": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" }, { "enabled": false, "name": "TLS_RSA_WITH_AES_256_GCM_SHA384" }, { "enabled": true, "name": "TLS_RSA_WITH_AES_256_CBC_SHA" } ], "connection_timeout": 60000, "protocol_versions": [ { "enabled": true, "name": "TLSv1.1" }, { "enabled": true, "name": "TLSv1.2" } ], "redirect_host": "10.0.0.1", "session_timeout": 2400 } } Successful Response:
Response Code:
202 Accepted
Response Headers:
Content-type: application/json
Response Body:
NodeHttpServiceProperties+

Example Response: same as GET https://<nsx-mgr>/api/v1/node/services/http Required Permissions: crud Feature: system_administration Additional Errors:

Read http service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/http/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/http/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": { "href": "/node/services/http/status", "rel": "self" }, "monitor_pid": 21135, "monitor_runtime_state": "running", "pids": [ 21137 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Update http service certificate

Applies a security certificate to the http service. In the POST request,
the CERTIFICATE_ID references a certificate created with the
/api/v1/trust-management APIs. Issuing this request causes the http service
to restart so that the service can begin using the new certificate. When the
POST request succeeds, it doesn't return a valid response. The request times
out because of the restart.
Request:
Method:
POST
URI Path:
/api/v1/node/services/http?action=apply_certificate
Request Headers:
n/a
Query Parameters:
CertificateId+
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/http?action=apply_certificate &certificate_id=$CERTIFICATE_ID$ (NOTE: remove line break) Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Example Response: Required Permissions: crud Feature: system_administration Additional Errors:

Restart the http service

Request:
Method:
POST
URI Path:
/api/v1/node/services/http?action=restart
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/http?action=restart Successful Response:
Response Code:
202 Accepted
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Description:
Restart the http service.
Additional Errors:

Start the http service

Request:
Method:
POST
URI Path:
/api/v1/node/services/http?action=start
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/http?action=start Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": { "href": "/node/services/http", "rel": "self" }, "monitor_pid": 4782, "monitor_runtime_state": "running", "pids": [ 4786 ], "runtime_state": "running" } Required Permissions: crud Feature: system_administration Description:
Start the http service.
Additional Errors:

Stop the http service

Request:
Method:
POST
URI Path:
/api/v1/node/services/http?action=stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/http?action=stop Successful Response:
Response Code:
202 Accepted
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Description:
Stop the http service. NSX API requests will no longer be serviced. To restart the http service again, invoke the NSX CLI command <code>start service http</code>.
Additional Errors:

Read NSX install-upgrade service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/install-upgrade
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/install-upgrade Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeInstallUpgradeServiceProperties+

Example Response: { "_schema": "NodeInstallUpgradeServiceProperties", "_self": "/node/services/install-upgrade", "service_name": "install-upgrade", "service_properties": { "enabled": true, "enabled_on": "192.168.110.31" } } Required Permissions: read Feature: system_administration Additional Errors:

Update NSX install-upgrade service properties

Request:
Method:
PUT
URI Path:
/api/v1/node/services/install-upgrade
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeInstallUpgradeServiceProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/services/install-upgrade { "service_name": "install-upgrade", "service_properties": { "enabled": false } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeInstallUpgradeServiceProperties+

Example Response: { "_schema": "NodeInstallUpgradeServiceProperties", "_self": "/node/services/install-upgrade", "service_name": "install-upgrade", "service_properties": { "enabled": false, "enabled_on": "None" } } Required Permissions: crud Feature: system_administration Additional Errors:

Read NSX install-upgrade service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/install-upgrade/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/install-upgrade/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/install-upgrade/status", "pids": [ 12976 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the NSX install-upgrade service

Request:
Method:
POST
URI Path:
/api/v1/node/services/install-upgrade?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/install-upgrade?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/install-upgrade", "pids": [ 13787 ], "runtime_state": "running" } Required Permissions: crud Feature: system_administration Additional Errors:

Read liagent service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/liagent
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/liagent Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Example Response: { "_schema": "NodeServiceProperties", "_self": { "href": "/node/services/liagent", "rel": "self" }, "service_name": "liagent" } Required Permissions: read Feature: system_administration Additional Errors:

Read liagent service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/liagent/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/liagent/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": { "href": "/node/services/liagent/status", "rel": "self" }, "pids": [], "runtime_state": "stopped" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the liagent service

Request:
Method:
POST
URI Path:
/api/v1/node/services/liagent?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/liagent?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Update service properties

Request:
Method:
PUT
URI Path:
/api/v1/node/services/manager
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeProtonServiceProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/services/manager { "service_name": "manager", "service_properties": { "logging_level": "DEBUG", "package_logging_level": [ { "logging_level": "INFO", "package_name": "com.vmware.nsx" }, { "logging_level": "DEBUG", "package_name": "com.vmware.nsx.management.switching" }, { "logging_level": "DEBUG", "package_name": "com.vmware.nsx.management.edge" }, { "logging_level": "INFO", "package_name": "com.vmware.nsx.management.container.restartor" }, { "logging_level": "ERROR", "package_name": "org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer" } ] } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeProtonServiceProperties+

Example Response: { "_schema": "NodeProtonServiceProperties", "_self": "/node/services/manager", "service_name": "manager", "service_properties": { "logging_level": "DEBUG", "package_logging_level": [ { "logging_level": "INFO", "package_name": "com.vmware.nsx" }, { "logging_level": "DEBUG", "package_name": "com.vmware.nsx.management.switching" }, { "logging_level": "DEBUG", "package_name": "com.vmware.nsx.management.edge" }, { "logging_level": "ERROR", "package_name": "org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer" }, { "logging_level": "INFO", "package_name": "com.vmware.nsx.management.container.restartor" } ] } } Required Permissions: crud Feature: system_administration Additional Errors:

Read service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/manager
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/manager Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeProtonServiceProperties+

Example Response: { "_schema": "NodeProtonServiceProperties", "_self": "/node/services/manager", "service_name": "manager", "service_properties": { "logging_level": "INFO", "package_logging_level": [ { "logging_level": "INFO", "package_name": "com.vmware.nsx" }, { "logging_level": "DEBUG", "package_name": "com.vmware.nsx.management.switching" }, { "logging_level": "DEBUG", "package_name": "com.vmware.nsx.management.edge" }, { "logging_level": "INFO", "package_name": "com.vmware.nsx.management.container.restartor" }, { "logging_level": "ERROR", "package_name": "org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer" } ] } } Required Permissions: read Feature: system_administration Additional Errors:

Read service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/manager/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/manager/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/manager/status", "monitor_pid": 1145, "monitor_runtime_state": "running", "pids": [ 1147 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Reset the logging levels to default values

Request:
Method:
POST
URI Path:
/api/v1/node/services/manager?action=reset-manager-logging-levels
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/manager?action=reset-manager-logging-levels Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Restart, start or stop the service

Request:
Method:
POST
URI Path:
/api/v1/node/services/manager?action=start|stop|restart
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/manager?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read Rabbit MQ service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/mgmt-plane-bus
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/mgmt-plane-bus Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Example Response: { "_schema": "NodeServiceProperties", "_self": { "href": "/node/services/mgmt-plane-bus", "rel": "self" }, "service_name": "mgmt-plane-bus" } Required Permissions: read Feature: system_administration Additional Errors:

Read Rabbit MQ service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/mgmt-plane-bus/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/mgmt-plane-bus/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": { "href": "/node/services/mgmt-plane-bus/status", "rel": "self" }, "monitor_pid": 1501, "monitor_runtime_state": "running", "pids": [ 1816 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the Rabbit MQ service

Request:
Method:
POST
URI Path:
/api/v1/node/services/mgmt-plane-bus?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/mgmt-plane-bus?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read appliance management service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/node-mgmt
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/node-mgmt Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Example Response: { "_schema": "NodeServiceProperties", "_self": "/node/services/node-mgmt", "service_name": "node-mgmt" } Required Permissions: read Feature: system_administration Additional Errors:

Read appliance management service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/node-mgmt/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/node-mgmt/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/node-mgmt/status", "monitor_pid": 19189, "monitor_runtime_state": "running", "pids": [ 19190 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart the node management service

Request:
Method:
POST
URI Path:
/api/v1/node/services/node-mgmt?action=restart
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/node-mgmt?action=restart Successful Response:
Response Code:
202 Accepted
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Read NSX Message Bus service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/nsx-message-bus
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/nsx-message-bus Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Example Response: { "_schema": "NodeServiceProperties", "_self": "/node/services/nsx-message-bus", "service_name": "nsx-message-bus" } Required Permissions: read Feature: system_administration Additional Errors:

Read NSX Message Bus service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/nsx-message-bus/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/nsx-message-bus/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/nsx-message-bus/status", "monitor_pid": 1, "monitor_runtime_state": "running", "pids": [ 18318, 18328, 18329 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the NSX Message Bus service

Request:
Method:
POST
URI Path:
/api/v1/node/services/nsx-message-bus?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/nsx-message-bus?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/nsx-message-bus", "monitor_pid": 1, "monitor_runtime_state": "running", "pids": [ 18318, 18328, 18329 ], "runtime_state": "running" } Required Permissions: crud Feature: system_administration Additional Errors:

Read NSX upgrade Agent service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/nsx-upgrade-agent
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/nsx-upgrade-agent Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Example Response: { "_schema": "NodeServiceProperties", "_self": "/node/services/nsx-upgrade-agent", "service_name": "nsx-upgrade-agent" } Required Permissions: read Feature: system_administration Additional Errors:

Read Nsx upgrade agent service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/nsx-upgrade-agent/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/nsx-upgrade-agent/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/nsx-upgrade-agent/status", "monitor_pid": 1, "monitor_runtime_state": "running", "pids": [ 17892 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the NSX upgrade agent service

Request:
Method:
POST
URI Path:
/api/v1/node/services/nsx-upgrade-agent?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/nsx-upgrade-agent?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/nsx-upgrade-agent", "monitor_pid": 1, "monitor_runtime_state": "running", "pids": [ 17892 ], "runtime_state": "running" } Required Permissions: crud Feature: system_administration Additional Errors:

Update NTP service properties

Request:
Method:
PUT
URI Path:
/api/v1/node/services/ntp
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeNtpServiceProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/services/ntp { "service_name": "ntp", "service_properties": { "servers": [ "0.ubuntu.pool.ntp.org", "1.ubuntu.pool.ntp.org", "2.ubuntu.pool.ntp.org", "3.ubuntu.pool.ntp.org", "ntp.ubuntu.com", "192.168.110.10" ] } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNtpServiceProperties+

Example Response: { "_schema": "NodeNtpServiceProperties", "_self": "/node/services/ntp", "service_name": "ntp", "service_properties": { "servers": [ "0.ubuntu.pool.ntp.org", "1.ubuntu.pool.ntp.org", "2.ubuntu.pool.ntp.org", "3.ubuntu.pool.ntp.org", "ntp.ubuntu.com", "192.168.110.10" ] } } Required Permissions: crud Feature: system_administration Additional Errors:

Read NTP service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/ntp
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/ntp Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeNtpServiceProperties+

Example Response: { "_schema": "NodeNtpServiceProperties", "_self": "/node/services/ntp", "service_name": "ntp", "service_properties": { "servers": [ "0.ubuntu.pool.ntp.org", "1.ubuntu.pool.ntp.org", "2.ubuntu.pool.ntp.org", "3.ubuntu.pool.ntp.org", "ntp.ubuntu.com" ] } } Required Permissions: read Feature: system_administration Additional Errors:

Read NTP service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/ntp/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/ntp/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/ntp/status", "pids": [ 6270, 6272 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the NTP service

Request:
Method:
POST
URI Path:
/api/v1/node/services/ntp?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/ntp?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/ntp", "pids": [ 6035, 6270, 6272 ], "runtime_state": "running" } Required Permissions: crud Feature: system_administration Additional Errors:

Read NSX Search service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/search
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Read NSX Search service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/search/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the NSX Search service

Request:
Method:
POST
URI Path:
/api/v1/node/services/search?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read SNMP service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/snmp
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/snmp Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSnmpServiceProperties+

Example Response: { "_schema": "NodeSnmpServiceProperties", "_self": "/node/services/snmp", "service_name": "snmp" "service_properties": { "start_on_boot": true } } Required Permissions: read Feature: system_administration Additional Errors:

Update SNMP service properties

Request:
Method:
PUT
URI Path:
/api/v1/node/services/snmp
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeSnmpServiceProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/services/snmp { "service_name": "snmp", "service_properties": { "communities": [{"access": "read_only", "community_string": "snmpcommunity"}], "start_on_boot": true } } { "service_name": "snmp", "service_properties": { "start_on_boot": false } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSnmpServiceProperties+

Example Response: { "_schema": "NodeSnmpServiceProperties", "_self": "/node/services/snmp", "service_name": "snmp" "service_properties": { "start_on_boot": false } } Required Permissions: crud Feature: system_administration Description:
Update SNMP service properties. The SNMP service is started if the communities property specifies a community or stopped if it contains an empty array. The start_on_boot property can only be true if a community is specified in the request or is already configured.
Additional Errors:

Read SNMP service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/snmp/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/snmp/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/snmp/status", "pids": [ 16754 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the SNMP service

Request:
Method:
POST
URI Path:
/api/v1/node/services/snmp?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/snmp?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/snmp", "pids": [ 16361 ], "runtime_state": "running" } Required Permissions: crud Feature: system_administration Additional Errors:

Update ssh service properties

Request:
Method:
PUT
URI Path:
/api/v1/node/services/ssh
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeSshServiceProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/services/ssh { "service_name": "ssh", "service_properties": { "start_on_boot": false } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSshServiceProperties+

Example Response: { "_schema": "NodeSshServiceProperties", "_self": "/node/services/ssh", "service_name": "ssh", "service_properties": { "start_on_boot": false } } Required Permissions: crud Feature: system_administration Additional Errors:

Read ssh service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/ssh
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/ssh Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSshServiceProperties+

Example Response: { "_schema": "NodeSshServiceProperties", "_self": "/node/services/ssh", "service_name": "ssh", "service_properties": { "start_on_boot": true } } Required Permissions: read Feature: system_administration Additional Errors:

Read ssh service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/ssh/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/ssh/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/ssh/status", "pids": [ 868 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Remove a host's fingerprint from known hosts file

Request:
Method:
POST
URI Path:
/api/v1/node/services/ssh?action=remove_host_fingerprint
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
KnownHostParameter+

Example Request: POST https://<nsx-mgr>/api/v1/node/services/ssh?action=remove_host_fingerprint { "host": "192.168.110.105" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Restart, start or stop the ssh service

Request:
Method:
POST
URI Path:
/api/v1/node/services/ssh?action=start|stop|restart
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/ssh?action=start Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": "/node/services/ssh", "pids": [ 15930 ], "runtime_state": "running" } Required Permissions: crud Feature: system_administration Additional Errors:

Read syslog service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/syslog
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/syslog Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Example Response: { "_schema": "NodeServiceProperties", "_self": { "href": "/node/services/syslog", "rel": "self" }, "service_name": "syslog" } Required Permissions: read Feature: system_administration Additional Errors:

List node syslog exporters

Returns the collection of registered syslog exporter rules, if any. The
rules specify the collector IP address and port, and the protocol to use.
Request:
Method:
GET
URI Path:
/api/v1/node/services/syslog/exporters
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/syslog/exporters Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSyslogExporterPropertiesListResult+

Example Response: { "result_count": 2, "results": [ { "exporter_name": "syslog1", "level": "INFO", "port": 514, "protocol": "TCP", "server": "192.168.0.2" }, { "exporter_name": "syslog2", "level": "CRIT", "port": 514, "protocol": "TCP", "server": "192.168.0.1" } ] } Required Permissions: read Feature: system_log Additional Errors:

Add node syslog exporter

Adds a rule for exporting syslog information to a specified server. The
required parameters are the rule name (exporter_name); severity level
(emerg, alert, crit, and so on); transmission protocol (TCP or UDP); and
server IP address or hostname. The optional parameters are the syslog port
number, which can be 1 through 65,535 (514, by default); facility level to
use when logging messages to syslog (kern, user, mail, and so on); and
message IDs (msgids), which identify the types of messages to export.
Request:
Method:
POST
URI Path:
/api/v1/node/services/syslog/exporters
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeSyslogExporterProperties+

Example Request: POST https://<nsx-mgr>/api/v1/node/services/syslog/exporters { "exporter_name": "syslog4", "facilities": ["KERN", "USER"], "level": "INFO", "msgids": ["tcpin", "tcpout"], "port": 514, "protocol": "TCP", "server": "192.168.0.4" } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
NodeSyslogExporterProperties+

Example Response: { "exporter_name": "syslog4", "facilities": [ "KERN", "USER" ], "level": "INFO", "msgids": [ "tcpin", "tcpout" ], "port": 514, "protocol": "TCP", "server": "192.168.0.4" } Required Permissions: crud Feature: system_log Additional Errors:

Delete node syslog exporter

Removes a specified rule from the collection of syslog exporter rules.
Request:
Method:
DELETE
URI Path:
/api/v1/node/services/syslog/exporters/<exporter-name>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/node/services/syslog/exporters/syslog4 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_log Additional Errors:

Read node syslog exporter

Returns information about a specific syslog collection point. Request:
Method:
GET
URI Path:
/api/v1/node/services/syslog/exporters/<exporter-name>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/syslog/exporters/syslog1 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSyslogExporterProperties+

Example Response: { "exporter_name": "syslog1", "level": "CRIT", "port": 514, "protocol": "TCP", "server": "192.168.0.1" } Required Permissions: read Feature: system_log Additional Errors:

Read syslog service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/syslog/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/services/syslog/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response: { "_schema": "NodeServiceStatusProperties", "_self": { "href": "/node/services/syslog/status", "rel": "self" }, "pids": [ 661 ], "runtime_state": "running" } Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop the syslog service

Request:
Method:
POST
URI Path:
/api/v1/node/services/syslog?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node/services/syslog?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read Telemetry service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/telemetry
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Read Telemetry service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/telemetry/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Restart, start or stop Telemetry service

Request:
Method:
POST
URI Path:
/api/v1/node/services/telemetry?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read ui service properties

Request:
Method:
GET
URI Path:
/api/v1/node/services/ui-service
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Read ui service status

Request:
Method:
GET
URI Path:
/api/v1/node/services/ui-service/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: read Feature: system_administration Additional Errors:

Restart, Start and Stop the ui service

Request:
Method:
POST
URI Path:
/api/v1/node/services/ui-service?action=restart|start|stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Required Permissions: crud Feature: system_administration Additional Errors:

Read node status

Returns information about the NSX Manager appliance's file system, CPU,
memory, disk usage, and uptime.
Request:
Method:
GET
URI Path:
/api/v1/node/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeStatusProperties+

Example Response: { "cpu_cores": 2, "file_systems": [ { "file_system": "/dev/sda2", "mount": "/", "total": 4790588, "type": "ext4", "used": 1402060 }, ...[content omitted for brevity] ], "load_average": [ 0.09, 0.1, 0.07 ], "mem_cache": 530348, "mem_total": 16430712, "mem_used": 3488064, "swap_total": 3997692, "swap_used": 0, "system_time": 1442278302776, "uptime": 22474490 } Required Permissions: read Feature: system_administration Additional Errors:

Read node support bundle

Request:
Method:
GET
URI Path:
/api/v1/node/support-bundle
Request Headers:
n/a
Query Parameters:
SupportBundleQueryParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/support-bundle Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/octet-stream
Response Body:
n/a

Example Response: Headers Content-Disposition : attachment;filename=nsx_support_bundle_20170818_002715.tgz Content-Type : application/x-tar Date : Thu, 18 Aug 2017 00:28:07 GMT Server : NSX Manager Transfer-Encoding : chunked Vmw-Task-Id : 421b38aa-e390-64b9-3fff-7ad6ebf59c40_10b1b5d6-0786-49a4-a61c-a1f64428b40e Required Permissions: read Feature: system_support_bundle Additional Errors:

List appliance management tasks

Request:
Method:
GET
URI Path:
/api/v1/node/tasks
Request Headers:
n/a
Query Parameters:
ApplianceManagementTaskQueryParameters+
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ApplianceManagementTaskListResult+

Required Permissions: read Feature: system_information Additional Errors:

Read task properties

Request:
Method:
GET
URI Path:
/api/v1/node/tasks/<task-id>
Request Headers:
n/a
Query Parameters:
ApplianceManagementSuppressRedirectQueryParameter+
Request Body:
n/a

Successful Response:
Response Code:
200 OK, 303 See Other
Response Headers:
Content-type: application/json
Response Body:
ApplianceManagementTaskProperties+

Required Permissions: read Feature: system_information Additional Errors:

Delete task

Request:
Method:
DELETE
URI Path:
/api/v1/node/tasks/<task-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: read Feature: system_administration Additional Errors:

Read asynchronous task response

Request:
Method:
GET
URI Path:
/api/v1/node/tasks/<task-id>/response
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK, 201 Created, 202 Accepted, 204 No Content, 303 See Other
Response Headers:
n/a
Response Body:
n/a

Required Permissions: read Feature: system_information Additional Errors:

Cancel specified task

Request:
Method:
POST
URI Path:
/api/v1/node/tasks/<task-id>?action=cancel
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: read Feature: system_administration Additional Errors:

List node users

Returns the list of users configued to log in to the NSX Manager appliance.
Request:
Method:
GET
URI Path:
/api/v1/node/users
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/users Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeUserPropertiesListResult+

Example Response: { "result_count": 3, "results": [ { "full_name": "root", "userid": 0, "username": "root" }, { "full_name": "", "userid": 10000, "username": "admin" }, { "full_name": "", "userid": 10002, "username": "audit" } ] } Required Permissions: read Feature: system_administration Additional Errors:

Read node user

Returns information about a specified user who is configued to log in to the
NSX Manager appliance
Request:
Method:
GET
URI Path:
/api/v1/node/users/<userid>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/users/10000 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeUserProperties+

Example Response: { "full_name": "", "userid": 10000, "username": "admin" } Required Permissions: read Feature: system_administration Additional Errors:

Update node user

Updates attributes of an existing NSX Manager appliance user. This method
cannot be used to add a new user. Modifiable attributes include the
username, full name of the user, and password. If you specify a password in
a PUT request, it is not returned in the response. Nor is it returned in a
GET request.
Request:
Method:
PUT
URI Path:
/api/v1/node/users/<userid>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeUserProperties+

Example Request: PUT https://<nsx-mgr>/api/v1/node/users/10000 { "full_name": "Jane L. Doe", "username": "admin1" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeUserProperties+

Example Response: { "full_name": "Jane L. Doe" "userid": 10000, "username": "admin1" } Required Permissions: crud Feature: system_administration Additional Errors:

List SSH keys from authorized_keys file for node user

Returns a list of all SSH keys from authorized_keys file for node user
Request:
Method:
GET
URI Path:
/api/v1/node/users/<userid>/ssh-keys
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/users/10000/ssh-keys Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
SshKeyPropertiesListResult+

Example Response: { "result_count": 2, "results": [ { "label": "user1@domain1" "type": "ssh-rsa" "value": "AAAAB3NzaC1yc2EAAAABIwAAAIEAywWhrwq4FjHt+UuwZcZePxtjtZOENFpOjufycaYso2nTlzNwnAQEQRfbqsUxKVtOtGxgApIkUvjRIjNBdJE6iOzvBXZhhJrM0GUDJragw7SMVIs/5xJBGAyHKJ1YUMGO7+nJTmsCLx6PFOlQYveuriiVVCCZerGCLH+UtSXK3z+l7hx9NiDg3/ylOLc3f3SLxrJKn0gMTgK7BHJFXo4PguuPjWZLVdUDX+XKiqtT2n4IsYs6N9qVFG3zUgNlEjZM47NK/ytAC0max98pK+QNzsuaQOo/IShJ1TOw5wwScflPArVJ2AyROqAe7cfQg7q12I9olASFd3U5NazfZCTYAvWA1kz9UZEWLJ1Br1XOkPqOleMM8KCp/PXzz8H0kISkMIji0/QuiZOPEBsKlszXjlALcXR8Mg1uiZVWy48i9JheyXyj1ToCj6cPScpgFHp3DAGSlKKbE1EFaVfeeyGAnHESuXC9wkSeFZCEyMJ+RgJxMkBXNZmyycbwsSqAeGJpMEUDlwzu2GD0obBz0HXqg9J1Xallop5AVDKfeszZcc=" }, { "label": "user2@domain2" "type": "ssh-rsa" "value": "AAAAB3NzaC1yc2EAAAABIwAAAIEA0KJDLOiiXj9XdMxiCT9KvaKfuxFQi+CIiklaN5hHsNgYOu7TijqyONEu5fONLoAo/cshLa+KuargyTrtizwcP4TPcTXZhhJrM0GUDJragw7SMVIs/5xJBGAyHKJ1YUMGO7+nJTmsCLx6PFOlQYveuriiVVCCZerGCLH+UtSXK3z+l7hx9NiDg3/ylOLc3f3SLxrJKn0gMTgK7BHJFXo4PguuPjWZLVdUDX+XKiqtT2n4IsYs6N9qVFG3zUgNlEjZM47NK/ytAC0max98pK+QNzsuaQOo/IShJ1TOw5wwScflPArVJ2AyROqAe7cfQg7q12I9olASFd3U5NazfZCTYAvWA1kz9UZEWLJ1Br1XOkPqOleMM8KCp/PXzz8H0kISkMIji0/QuiZOPEBsKlszXjlALcXR8Mg1uiZVWy48i9JheyXyj1ToCj6cPScpgFHp3DAGSlKKbE1EFaVfeeyGAnHESlnDDg3Gq5xSsB9Okqm3V5t8GpFaJbV68BxQ4BK6HJ21A3CinV4LdV3hR/OBUbDG2EcI+ZKRDjlpJuu4YU=" } ] } Required Permissions: read Feature: system_administration Additional Errors:

Add SSH public key to authorized_keys file for node user

Request:
Method:
POST
URI Path:
/api/v1/node/users/<userid>/ssh-keys?action=add_ssh_key
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
SshKeyProperties+

Example Request: POST https://<nsx-mgr>/api/v1/node/users/10000/ssh-keys?action=add_ssh_key { "label": "user1@domain1", "type": "ssh-rsa", "value": "AAAAB3NzaC1yc2EAAAABIwAAAIEAywWhrwq4FjHt+UuwZcZePxtjtZOENFpOjufycaYso2nTlzNwnAQEQRfbqsUxKVtOtGxgApIkUvjRIjNBdJE6iOzvBXZhhJrM0GUDJragw7SMVIs/5xJBGAyHKJ1YUMGO7+nJTmsCLx6PFOlQYveuriiVVCCZerGCLH+UtSXK3z+l7hx9NiDg3/ylOLc3f3SLxrJKn0gMTgK7BHJFXo4PguuPjWZLVdUDX+XKiqtT2n4IsYs6N9qVFG3zUgNlEjZM47NK/ytAC0max98pK+QNzsuaQOo/IShJ1TOw5wwScflPArVJ2AyROqAe7cfQg7q12I9olASFd3U5NazfZCTYAvWA1kz9UZEWLJ1Br1XOkPqOleMM8KCp/PXzz8H0kISkMIji0/QuiZOPEBsKlszXjlALcXR8Mg1uiZVWy48i9JheyXyj1ToCj6cPScpgFHp3DAGSlKKbE1EFaVfeeyGAnHESuXC9wkSeFZCEyMJ+RgJxMkBXNZmyycbwsSqAeGJpMEUDlwzu2GD0obBz0HXqg9J1Xallop5AVDKfeszZcc=", "password": "Pa$$w0rd" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Remove SSH public key from authorized_keys file for node user

Request:
Method:
POST
URI Path:
/api/v1/node/users/<userid>/ssh-keys?action=remove_ssh_key
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
SshKeyBaseProperties+

Example Request: POST https://<nsx-mgr>/api/v1/node/users/10000/ssh-keys?action=remove_ssh_key { "label": "user1@domain1", "password": "Pa$$w0rd" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Read node version

Request:
Method:
GET
URI Path:
/api/v1/node/version
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/version Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeVersion+

Example Response: { "node_version": "1.0.0.0.0.3063398" } Required Permissions: read Feature: system_information Additional Errors:

Restart or shutdown node

Restarts or shuts down the NSX Manager appliance. Request:
Method:
POST
URI Path:
/api/v1/node?action=restart|shutdown
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/node?action=restart Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: system_administration Additional Errors:

Nsx Component Administration: Backup Restore Management

Nsx Component Administration: Backup Restore Management: Backup

Associated URIs:

Configure backup

Configure file server and timers for automated backup.
If secret fields are omitted (password, passphrase)
then use the previously set value.
Request:
Method:
PUT
URI Path:
/csmapi/api/v1/cluster/backups/config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
BackupConfiguration+

Example Request: PUT https://<nsx-mgr>/api/v1/cluster/backups/config { "backup_enabled" : true, "backup_schedule":{ "resource_type": "WeeklyBackupSchedule", "days_of_week":[ 1, 3, 5 ], "hour_of_day":0, "minute_of_day":0 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin", "password":"default" } }, "directory_path":"/nsx-backups" }, "passphrase":"swordfish", "inventory_summary_interval":300 }| PUT https://<nsx-mgr>/api/v1/cluster/backups/config { "backup_enabled" : true, "backup_schedule":{ "resource_type": "IntervalBackupSchedule", "seconds_between_backups":3600 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin", "password":"default" } }, "directory_path":"/nsx-backups" }, "passphrase":"swordfish", "inventory_summary_interval":300 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BackupConfiguration+

Required Permissions: crud Feature: utilities_backup Additional Errors:

Get backup configuration

Get a configuration of a file server and timers for automated backup.
Fields that contain secrets (password, passphrase) are not returned.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/backups/config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BackupConfiguration+

Example Response: { "backup_enabled" : true; "backup_schedule":{ "resource_type": "WeeklyBackupSchedule", "days_of_week":[ 1, 3, 5 ], "hour_of_day":0, "minute_of_day":0 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin" } }, "directory_path":"/nsx-backups" }, "inventory_summary_interval":300 } Required Permissions: read Feature: utilities_backup Additional Errors:

Get backup history

Get history of previous backup operations
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/backups/history
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BackupOperationHistory+

Example Response: { "cluster_backup_statuses": [ { "backup_id" : "2128af2d-d763-4a27-80e0-4933af7e4824-1462221358", "start_time": 1523334840897, "end_time": 1523334916419, "success": true } ], "node_backup_statuses": [ { "backup_id" : "3128af2d-d763-4a27-80e0-4933af7e4824-1462221359", "start_time": 1523411768398, "end_time": 1523411844682, "success": false, "error_code": "BACKUP_SERVER_TIMEOUT", "error_message": "File server is not reachable, please check connectivity to file server" } ], "inventory_backup_statuses": [ { "backup_id" : "4128af2d-d763-4a27-80e0-4933af7e4824-1462221360", "start_time": 1523411625510, "end_time": 1523411701163, "success": true } ] } Required Permissions: read Feature: utilities_backup Additional Errors:

Get backup status

Get status of active backup operations
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/backups/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CurrentBackupOperationStatus+

Example Response: { "operation_type": "backup", "backup_id": "fec18cee-ccf7-4d7c-bcc2-8634b08195cd-1523411326", "start_time": 1523411326952, "end_time": 1523411628558, "current_step": "BACKUP_CREATING_CLUSTER_BACKUP" } Required Permissions: read Feature: utilities_backup Additional Errors:

Get ssh fingerprint of remote(backup) server

Get SHA256 fingerprint of ECDSA key of remote server. The caller should
independently verify that the key is trusted.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster/backups?action=retrieve_ssh_fingerprint
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
RemoteServerFingerprintRequest+

Example Request: POST https:///api/v1/cluster/backups?action=retrieve_ssh_fingerprint { "server":"10.1.2.3", "port":22 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RemoteServerFingerprint+

Example Response: { "server":"10.1.2.3", "port":22, "ssh_fingerprint":"SHA256:Apqs2qIrQ5r6U8xyv2czZjTniNsipz6SlCONf4kR/Gw" } Required Permissions: read Feature: utilities_backup Additional Errors:

Request one-time backup

Request one-time backup. The backup will be uploaded using the
same server configuration as for automatic backup.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster?action=backup_to_remote
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/cluster?action=backup_to_remote Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: utilities_backup Additional Errors:

Request one-time inventory summary.

Request one-time inventory summary. The backup will be uploaded using the
same server configuration as for an automatic backup.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster?action=summarize_inventory_to_remote
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/cluster?action=summarize_inventory_to_remote Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: utilities_backup Additional Errors:

Nsx Component Administration: Backup Restore Management: Restore

Associated URIs:

List timestamps of all available Cluster Backups.

Returns timestamps for all backup files that are available
on the SFTP server.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/restore/backuptimestamps
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster/restore/backuptimestamps Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterBackupInfoListResult+

Example Response: { "results": [ { "timestamp": 1482253939013, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" }, { "timestamp": 1482081398404, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" }, { "timestamp": 1481908598404, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" }, { "timestamp": 1481735798404, "ip_address": "64.233.187.105", "node_id": "21EA6850-217F-41A2-B3CF-F322A882C54E" } ] } Required Permissions: read Feature: utilities_backup Additional Errors:

Get Restore configuration

Get configuration information for the file server used to store backed-up files.
Fields that contain secrets (password, passphrase) are not returned.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/restore/config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RestoreConfiguration+

Example Response: { "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin" } }, "directory_path":"/nsx-backups" } } Required Permissions: read Feature: utilities_backup Additional Errors:

Configure Restore SFTP server credentials

Configure file server where the backed-up files used for the Restore
operation are available.
Request:
Method:
PUT
URI Path:
/csmapi/api/v1/cluster/restore/config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
RestoreConfiguration+

Example Request: PUT https://<nsx-mgr>/api/v1/cluster/restore/config { "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin", "password":"default" } }, "directory_path":"/nsx-backups" }, "passphrase":"swordfish" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
RestoreConfiguration+

Required Permissions: crud Feature: utilities_backup Additional Errors:

List resources for a given instruction, to be shown to/executed by users.

For restore operations requiring user input e.g. performing an action,
accepting/rejecting an action, etc. the information to be conveyed to users
is provided in this call.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/restore/instruction-resources
Request Headers:
n/a
Query Parameters:
ActionableResourceListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster/restore/instruction-resources ?instruction_id=48F45150-038C-4664-B468-36FFE1B356F9 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ActionableResourceListResult+

Example Response: { "result_count": 2, "cursor": "00361b9f1d54-2f05-441e-9851-c42518cc8b1dasdfds", "results": [ { "id": "4630aadd-25d7-4c73-b03c-227ac314dfc4", "display_name": "db-server", "resource_type": "FabricNode", "ip_address": "10.23.12.77" }, { "id": "3cc5e971-0329-4f35-966a-7cd879171688", "display_name": "app-server", "resource_type": "FabricNode", "ip_address": "10.23.12.78" } ] } Required Permissions: read Feature: utilities_backup Additional Errors:

Query Restore Request Status

Returns status information for the specified NSX cluster restore request.
Request:
Method:
GET
URI Path:
/api/v1/cluster/restore/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster/restore/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response: { "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1415830945573, "restore_start_time": 1415830945573, "restore_end_time": 1415830947433, "step": { "step_number": 7, "value": "MANAGER_RESTARTING", "description": "Restarting manager", "status": { "value": "RUNNING", "description": "The manager is restarting" } }, "status": { "value": "RUNNING", "description": "The operation is currently running" }, "total_steps": 11, #TODO: Fill in endpoints when state machine is finalized. "endpoints": [], "instructions": [ { "id": "48F45150-038C-4664-B468-36FFE1B356F9", "name": "Reset Fabric Nodes", "actions": [ "Log into these fabric nodes with root access and run reset_nsx_after_mp_restore.sh", "Restart node agent" ], "fields": ["display_name", "id", "resource_type", "IP"] }, { ... } ] } Required Permissions: read Feature: utilities_backup Additional Errors:

Advance any suspended restore operation

Advance any currently suspended restore operation. The operation might
have been suspended because (1) the user had suspended it previously, or
(2) the operation is waiting for user input, to be provided as a
part of the POST request body. This operation is only valid
when a GET cluster/restore/status returns a status with value SUSPENDED.
Otherwise, a 409 response is returned.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster/restore?action=advance
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
AdvanceClusterRestoreRequest+

Example Request: POST https://<nsx-mgr>/api/v1/cluster/restore?action=advance { "data": [ { "id": "423F4EBE-7D65-D782-4B7B-BD3EDEF111A4", "resoures": [ { "target_type": "LogicalSwitch", "target_display_name": "zone3LS", "is_valid": true, "target_id": "983B5FB6-C4E9-4FC9-81DC-1B27D5D09EC9" }, { "target_type": "LogicalSwitch", "target_display_name": "zone4LS", "is_valid": true, "target_id": "86f2b632-2d0e-46f2-9527-5baea8e273cd" } ] }, { "id": "52113C04-489E-4D47-B3FB-F3573155B24E", "resoures": [ { "target_type": "TransportNode", "target_display_name": "zone3TN", "is_valid": true, "target_id": "86f2b632-2d0e-46f2-9527-5baea8e273cd" } ] } ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response: { "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1435298084391, "restore_start_time": 1483463180963, "restore_end_time": null, "step": { "step_number": 4, "value": "SFTP_COPY_START", "description": "Starting sftp copy" "status": { "value": "RUNNING", "description": "Sftp copy starting" } }, "status": { "value": "RUNNING", "description": "The operation is currently running" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=suspend', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] } Required Permissions: crud Feature: utilities_backup Additional Errors:

Cancel any running restore operation

Cancel any currently running restore operation. If there exists a currently
running step, it is allowed to finish. The system is not rolled back to the
pre-restore state. This operation is only valid when a
GET cluster/restore/status returns a status with value RUNNING or SUSPENDED.
Otherwise, a 409 response is returned.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster/restore?action=cancel
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/cluster/restore?action=cancel Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response: { "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1435298084391, "restore_start_time": 1483463180963, "restore_end_time": null, "step": { "step_number": 1, "value": "RESTORE_INITIATED", "description": "Starting cluster restore" "status": { "value": "RUNNING", "description": "Cluster restore initiated" } }, "status": { "value": "SUSPENDING", "description": "A suspend request is being processed" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=resume', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] } Required Permissions: crud Feature: utilities_backup Additional Errors:

Retry any failed restore operation

Retry any currently in-progress, failed restore operation. Only the last
step of the multi-step restore operation would have failed,and only that
step is retried. This operation is only valid when a
GET cluster/restore/status returns a status with value FAILED. Otherwise,
a 409 response is returned.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster/restore?action=retry
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/cluster/restore?action=retry Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response: { "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1435298084391, "restore_start_time": 1483463180963, "restore_end_time": null, "step": { "step_number": 4, "value": "SFTP_COPY_START", "description": "Starting sftp copy" "status": { "value": "RUNNING", "description": "Sftp copy starting" } }, "status": { "value": "RUNNING", "description": "The operation is currently running" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=suspend', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] } Required Permissions: crud Feature: utilities_backup Additional Errors:

Initiate a restore operation

Start the restore of an NSX cluster, from some previously
backed-up configuration. This operation is only valid
when a GET cluster/restore/status returns a status with value NOT_STARTED.
Otherwise, a 409 response is returned.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster/restore?action=start
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
InitiateClusterRestoreRequest+

Example Request: POST https://<nsx-mgr>/api/v1/cluster/restore?action=start { "node_id": "2128af2d-d763-4a27-80e0-4933af7e4824", "timestamp" : 1435298084391 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response: { "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1435298084391, "restore_start_time": 1483463180963, "restore_end_time": null, "step": { "step_number": 1, "value": "RESTORE_INITIATED", "description": "Starting cluster restore" "status": { "value": "RUNNING", "description": "The operation is currently running" } }, "status": { "value": "RUNNING", "description": "The operation is currently running" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=suspend', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] } Required Permissions: crud Feature: utilities_backup Additional Errors:

Suspend any running restore operation

Suspend any currently running restore operation. The restore operation is
made up of a number of steps. When this call is issued, any currently
running step is allowed to finish (successfully or with errors), and the
next step (and therefore the entire restore operation) is suspended until
a subsequent resume or cancel call is issued. This operation is only valid
when a GET cluster/restore/status returns a status with value RUNNING.
Otherwise, a 409 response is returned.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster/restore?action=suspend
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/cluster/restore?action=suspend Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response: { "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1435298084391, "restore_start_time": 1483463180963, "restore_end_time": null, "step": { "step_number": 1, "value": "RESTORE_INITIATED", "description": "Starting cluster restore" "status": { "value": "RUNNING", "description": "Cluster restore initiated" } }, "status": { "value": "SUSPENDING", "description": "A suspend request is being processed" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=resume', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] } Required Permissions: crud Feature: utilities_backup Additional Errors:

Nsx Component Administration: Cluster Management

Associated URIs:

Read Cluster Configuration

Returns information about the NSX cluster configuration. An NSX cluster has
two functions or purposes, commonly referred to as "roles." These two roles
are control and management. Each NSX installation has a single cluster.
Separate NSX clusters do not share data. In other words, a given data-plane
node is attached to only one cluster, not to multiple clusters.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterConfig+

Example Response: { "cluster_id": "bc72f9d5-976d-4856-bf15-7480307146bb", "mgmt_cluster_changes_allowed": true, "control_cluster_changes_allowed": true, "_revision": 0 } Required Permissions: read Additional Errors:

Add a controller node to the cluster

Adds a new controller node to the NSX cluster. Request:
Method:
POST
URI Path:
/csmapi/api/v1/cluster/nodes
Request Headers:
n/a
Query Parameters:
AddClusterNodeAction+
Request Body:
AddClusterNodeSpec+

Example Request: Controller Node POST https://<nsx-mgr>/api/v1/cluster/nodes?action=add_cluster_node { "external_id": "4c539859-1451-439a-a920-f64492863b16", "controller_role_config": { "type": "AddControllerNodeSpec", "host_msg_client_info": { "shared_secret": "secret1" }, "mpa_msg_client_info": { "shared_secret": "secret1" } } } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
ClusterNodeConfig+

Example Response: Controller Node { "_revision": 0, "id": "7e36956a-85c4-4c3e-a883-8d26592146f1", "resource_type": "ClusterNodeConfig", "external_id": "4c539859-1451-439a-a920-f64492863b16", "controller_role": { "type": "ControllerClusterRoleConfig", "host_msg_client_info": { "account_name": "cvn-ccp-7e36956a-85c4-4c3e-a883-8d26592146f1" }, "mpa_msg_client_info": { "account_name": "cvn-ccp-mpa-abcdef12-85c4-4c3e-a883-8d26592146f1" }, "control_cluster_listen_addr": { "port": 0 }, "control_plane_listen_addr": { "port": 0 } }, "_create_time": 1416221408704, "_create_user": "system", "_last_modified_user": "system", "_last_modified_time": 1416221408704 } Required Permissions: crud Additional Errors:

List Cluster Node Configurations

Returns information about all NSX cluster nodes. Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/nodes
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster/nodes Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterNodeConfigListResult+

Example Response: { "result_count": 3, "results": [ { "resource_type": "ClusterNodeConfig", "id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "display_name": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "64b99fac51f5b8996b158fc8c18af8d9379f6faa9b127a933446c701df809d24", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-5d1212b4-6e1e-47d4-b9e7-2e38e018b8f2" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "e4c359bfb8f7ca827173effe52a726cf1df0209b7035a98a773a827a5b3365bd", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "7eda54d0dcee4463573f40b1869552f0e248dd47b9d6b47b727459b0ab0c40ba", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" } }, "appliance_mgmt_listen_addr": "192.168.110.48", "external_id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "_create_time": 1445540755333, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445540868201, "_create_user": "admin", "_revision": 5 }, { "resource_type": "ClusterNodeConfig", "id": "4206A8C8-36D0-F37E-54F0-76D206541B9C", "display_name": "4206A8C8-36D0-F37E-54F0-76D206541B9C", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "f082b28c306c045f8663f9cf759fc047410e465c3403c05682f4fb2cafb961f8", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.49" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-318813d1-e23f-4906-b5e3-ebb30f6f93ea" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "8fda7907ed769628887ccc55d4fc9391febad9ce8556ca78dc7abe0025e5571a", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.49" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "e93e093fe7e25d11eb4b5b0799d90e1285f7d87f333b2bcac3a32b65cd9ae6c8", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.49" } }, "appliance_mgmt_listen_addr": "192.168.110.49", "external_id": "4206A8C8-36D0-F37E-54F0-76D206541B9C", "_create_time": 1445473397114, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445473423066, "_create_user": "system", "_revision": 1 }, { "resource_type": "ClusterNodeConfig", "id": "4206D639-8620-96DB-2A5A-F3DFEB4C03C0", "display_name": "4206D639-8620-96DB-2A5A-F3DFEB4C03C0", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "923314e232c29ba15aef12c8e9df44a5ddfb206479d66ac13f9a47f78b7fcc02", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.50" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-7deeae7c-b52c-49ce-b9da-4b05e46ba0d7" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "a5778682201f1256f385372fd803ceef1913b54617d442d311d17559bd13620e", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.50" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "f99a8263bae620ca0f4bd0e97398ddeb0456412d491a6f5c204fa01cd81febf6", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.50" } }, "appliance_mgmt_listen_addr": "192.168.110.50", "external_id": "4206D639-8620-96DB-2A5A-F3DFEB4C03C0", "_create_time": 1445540972020, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445541093369, "_create_user": "admin", "_revision": 3 } ] } Required Permissions: read Additional Errors:

Remove a controller node from the cluster

Removes the specified controller node from the NSX cluster. Before you can
remove a controller node from the cluster, you must shut down the controller
service with the "stop service controller" command.
Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/cluster/nodes/<node-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/cluster/nodes/4845ae38-af61-4205-9998-5b0a026bb27e Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Read Cluster Node Configuration

Returns information about the specified NSX cluster node. Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/nodes/<node-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster/nodes/4206C988-8227-CEE9-D9AF-1C581AD84A03 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterNodeConfig+

Example Response: { "resource_type": "ClusterNodeConfig", "id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "display_name": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "manager_role": { "type": "ManagementClusterRoleConfig", "mgmt_cluster_listen_addr": { "port": 9090, "certificate_sha256_thumbprint": "64b99fac51f5b8996b158fc8c18af8d9379f6faa9b127a933446c701df809d24", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mpa_msg_client_info": { "account_name": "cvn-mp-mpa-5d1212b4-6e1e-47d4-b9e7-2e38e018b8f2" }, "api_listen_addr": { "port": 443, "certificate_sha256_thumbprint": "e4c359bfb8f7ca827173effe52a726cf1df0209b7035a98a773a827a5b3365bd", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" }, "mgmt_plane_listen_addr": { "port": 5671, "certificate_sha256_thumbprint": "7eda54d0dcee4463573f40b1869552f0e248dd47b9d6b47b727459b0ab0c40ba", "certificate": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "ip_address": "192.168.110.48" } }, "appliance_mgmt_listen_addr": "192.168.110.48", "external_id": "4206C988-8227-CEE9-D9AF-1C581AD84A03", "_create_time": 1445540755333, "_last_modified_user": "node-mgmt", "_system_owned": false, "_last_modified_time": 1445540868201, "_create_user": "admin", "_revision": 5 } Required Permissions: read Additional Errors:

Read Cluster Node Status

Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/nodes/<node-id>/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster/nodes/<node-id>/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterNodeStatus+

Example Response: { "system_status": { "mem_used": 2498348, "system_time": 1445560337000, "file_systems": [ { "file_system": "/dev/sda2", "total": 4790588, "used": 1652564, "type": "ext4", "mount": "/" }, { "file_system": "none", "total": 4, "used": 0, "type": "tmpfs", "mount": "/sys/fs/cgroup" }, { "file_system": "udev", "total": 8206636, "used": 4, "type": "devtmpfs", "mount": "/dev" }, { "file_system": "tmpfs", "total": 1643052, "used": 716, "type": "tmpfs", "mount": "/run" }, { "file_system": "none", "total": 5120, "used": 0, "type": "tmpfs", "mount": "/run/lock" }, { "file_system": "none", "total": 8215252, "used": 0, "type": "tmpfs", "mount": "/run/shm" }, { "file_system": "none", "total": 102400, "used": 0, "type": "tmpfs", "mount": "/run/user" }, { "file_system": "/dev/sda1", "total": 967320, "used": 32672, "type": "ext4", "mount": "/boot" }, { "file_system": "/dev/sda3", "total": 4790588, "used": 9784, "type": "ext4", "mount": "/os_bak" }, { "file_system": "/dev/mapper/nsx-config", "total": 3869352, "used": 7808, "type": "ext4", "mount": "/config" }, { "file_system": "/dev/mapper/nsx-config__bak", "total": 3869352, "used": 7800, "type": "ext4", "mount": "/config_bak" }, { "file_system": "/dev/mapper/nsx-tmp", "total": 3869352, "used": 7944, "type": "ext4", "mount": "/tmp" }, { "file_system": "/dev/mapper/nsx-image", "total": 9710112, "used": 21988, "type": "ext4", "mount": "/image" }, { "file_system": "/dev/mapper/nsx-repository", "total": 24473988, "used": 180108, "type": "ext4", "mount": "/repository" }, { "file_system": "/dev/mapper/nsx-var", "total": 9710112, "used": 163268, "type": "ext4", "mount": "/var" } ], "load_average": [ 0.07000000029802322, 0.3700000047683716, 0.3499999940395355 ], "swap_total": 3997692, "mem_cache": 381336, "cpu_cores": 4, "source": "cached", "mem_total": 16430504, "swap_used": 0, "uptime": 91774000 }, "mgmt_cluster_status": { "mgmt_cluster_status": "CONNECTED" }, "version": "1.0.0.0.0.3154214" } Required Permissions: read Additional Errors:

Read Cluster Status

Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/nodes/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClustersAggregateInfo+

Required Permissions: read Additional Errors:

Read Cluster Status

Returns status information for the NSX cluster control role and management
role.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/cluster/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/cluster/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterStatus+

Example Response: { "control_cluster_status": { "status": "STABLE" }, "mgmt_cluster_status": { "online_nodes": [ { "mgmt_cluster_listen_ip_address": "192.168.110.31", "uuid": "42311EA1-D13F-C347-A2E4-7821B20F31BE" } ], "status": "STABLE" } } Required Permissions: read Additional Errors:

Nsx Component Administration: Nsx Administration

Associated URIs:

Read NSX Management nodes global configuration.

Returns the NSX Management nodes global configuration.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/configs/management
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/configs/management Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ManagementConfig+

Example Response: { "publish_fqdns": true, "_revision": 0 } Required Permissions: read Additional Errors:

Update NSX Management nodes global configuration

Modifies the NSX Management nodes global configuration. Request:
Method:
PUT
URI Path:
/csmapi/api/v1/configs/management
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ManagementConfig+

Example Request: PUT https://<nsx-mgr>/api/v1/configs/management { "publish_fqdns": true, "_revision": 0 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ManagementConfig+

Example Response: { "publish_fqdns": true, "_revision": 1 } Required Permissions: crud Additional Errors:

Nsx Component Administration: Trust Management

Associated URIs:

Return the Properties of a Trust Manager

Returns information about the supported algorithms and key sizes. Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TrustManagementData+

Example Response: { "supported_algorithms": [ { "key_size": [ 2048, 3072 ], "name": "RSA" }, { "key_size": [ 2048 ], "name": "DSA" } ] } Required Permissions: read Feature: trust_certificates Additional Errors:

Return the list of principal identities

Returns the list of principals registered with a certificate. Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/principal-identities
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/principal-identities Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PrincipalIdentityList+

Example Response: { [ { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "name": "web-ui", "node_id": "node-1", "permission_group": "read_write_api_users", "role": "enterprise_admin", "is_protected": "true", "certificate_id" : "bbd3032d-728e-44d4-9914-d4f81c9972cc" }, { "id" : "ebd3032d-728e-44d4-9914-d4f81c6783ed", "name": "open-stack", "node_id": "node-2", "permission_group": "undefined", "role": "enterprise_admin", "is_protected": "true", "certificate_id" : "cbd3032d-728e-44d4-9914-d4f81c9972cc" } ] } Required Permissions: read Feature: trust_principal_identities Additional Errors:

Register a name-certificate combination.

Associates a principal's name with a certificate that is used to authenticate.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/principal-identities
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
PrincipalIdentity+

Example Request: POST https://<nsx-mgr>/api/v1/trust-management/principal-identities { "name": "open-stack", "node_id": "node-2", "role": "enterprise_admin", "is_protected": "true", "certificate_id" : "abd3032d-728e-44d4-9914-d4f81c9972cc" } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
PrincipalIdentity+

Example Response: { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "name": "open-stack", "node_id": "node-2", "permission_group": "undefined", "role": "enterprise_admin", "is_protected": "true", "certificate_id" : "abd3032d-728e-44d4-9914-d4f81c9972cc" } Required Permissions: crud Feature: trust_principal_identities Additional Errors:

Get a Principal Identity

Get a stored principal identity
Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/principal-identities/<principal-identity-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/principal-identities/ebd3032d-728e-44d4-9914-d4f81c9972cb Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PrincipalIdentity+

Example Response: { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "name": "open-stack", "node_id": "node-2", "permission_group": "undefined", "role": "network_engineer", "is_protected": "false", "certificate_id" : "abd3032d-728e-44d4-9914-d4f81c9972cc" } Required Permissions: read Feature: trust_principal_identities Additional Errors:

Delete a principal identity

Delete a principal identity. It does not delete the certificate.
Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/trust-management/principal-identities/<principal-identity-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/trust-management/principal-identities/ebd3032d-728e-44d4-9914-d4f81c9972cb Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: trust_principal_identities Additional Errors:

Update a Principal Identity's certificate

Update a principal identity's certificate
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/principal-identities?action=update_certificate
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
UpdatePrincipalIdentityCertificateRequest+

Example Request: POST https://<nsx-mgr>/api/v1/trust-management/principal-identities?action=update_certificate { "principal_identity_id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "certificate_id" : "abd3032d-728e-44d4-9914-d4f81c9972cc" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PrincipalIdentity+

Example Response: { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "name": "open-stack", "node_id": "node-2", "permission_group": "undefined", "role": "network_engineer", "is_protected": "false", "certificate_id" : "abd3032d-728e-44d4-9914-d4f81c9972cc" } Required Permissions: crud Feature: trust_principal_identities Additional Errors:

Nsx Component Administration: Trust Management: Certificate

Associated URIs:

Return All the User-Facing Components' Certificates

Returns all certificate information viewable by the user, including each
certificate's UUID; resource_type (for example, certificate_self_signed,
certificate_ca, or certificate_signed); pem_encoded data; and history of the
certificate (who created or modified it and when). For additional
information, include the ?details=true modifier at the end of the request
URI.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/certificates
Request Headers:
n/a
Query Parameters:
ListCertParameter+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/certificates Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CertificateList+

Example Response: { "result_count": 2, "results": [ { "id": "2e15955d-acd1-4f49-abae-0c6ea65bf437", "resource_type": "certificate_ca", "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n", "_last_modified_time": 1413369285797, "_create_time": 1413369285797, "_create_user": "admin", "_last_modified_user": "admin" }, { "id": "506d00d6-bfd5-4ebe-8b7f-0236f8de4792", "resource_type": "certificate_signed", "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n", "_last_modified_time": 1413369285811, "_create_time": 1413369285811, "_create_user": "admin", "_last_modified_user": "admin" } ] } Required Permissions: read Feature: trust_certificates Additional Errors:

Delete Certificate for the Given Certificate ID

Removes the specified certificate. The private key associated with the
certificate is also deleted.
Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/trust-management/certificates/<cert-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/trust-management/certificates/7ded7754-a2fb-48cd-b534-f1f4a980d827 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: trust_certificates Additional Errors:

Show Certificate Data for the Given Certificate ID

Returns information for the specified certificate ID, including the
certificate's UUID; resource_type (for example, certificate_self_signed,
certificate_ca, or certificate_signed); pem_encoded data; and history of the
certificate (who created or modified it and when). For additional
information, include the ?details=true modifier at the end of the request
URI.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/certificates/<cert-id>
Request Headers:
n/a
Query Parameters:
GetCertParameter+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/certificates/506d00d6-bfd5-4ebe-8b7f-0236f8de4792 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
Certificate+

Example Response: { "id": "506d00d6-bfd5-4ebe-8b7f-0236f8de4792", "resource_type": "certificate_signed", "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n", "_last_modified_time": 1413369285811, "_create_time": 1413369285811, "_create_user": "admin", "_last_modified_user": "admin" } Required Permissions: read Feature: trust_certificates Additional Errors:

Add a New Certificate

Adds a new private-public certificate or a chain of certificates (CAs) and,
optionally, a private key that can be applied to one of the user-facing
components (appliance management or edge). The certificate and the key
should be stored in PEM format. If no private key is provided, the
certificate is used as a client certificate in the trust store.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/certificates?action=import
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
TrustObjectData+

Example Request: POST https://<nsx-mgr>/api/v1/trust-management/certificates?action=import { "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n", "private_key": "-----BEGIN RSA PRIVATE KEY----------END RSA PRIVATE KEY-----\n", "passphrase": "1234" } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
CertificateList+

Example Response: { "results": [ { "id": "2e15955d-acd1-4f49-abae-0c6ea65bf437", "resource_type": "certificate_ca", "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n", "_last_modified_time": 1413369285797, "_create_time": 1413369285797, "_create_user": "admin", "_last_modified_user": "admin" }, { "id": "506d00d6-bfd5-4ebe-8b7f-0236f8de4792", "resource_type": "certificate_signed", "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n", "_last_modified_time": 1413369285811, "_create_time": 1413369285811, "_create_user": "admin", "_last_modified_user": "admin" } ] } Required Permissions: crud Feature: trust_certificates Additional Errors:

Nsx Component Administration: Trust Management: Crl

Associated URIs:

Return All Added CRLs

Returns information about all CRLs. For additional information, include the
?details=true modifier at the end of the request URI.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/crls
Request Headers:
n/a
Query Parameters:
ListCertParameter+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/crls Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CrlList+

Example Response: { "result_count": 1, "results": [ { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "display_name": "igloo Certificate Authority", "resource_type": "crl", "pem_encoded": "-----BEGIN X509 CRL----------END X509 CRL-----\n", "_last_modified_time": 1413387436438, "_create_time": 1413386249116, "_create_user": "admin", "_last_modified_user": "admin" } ] } Required Permissions: read Feature: trust_crls Additional Errors:

Delete a CRL

Deletes an existing CRL. Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/trust-management/crls/<crl-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/trust-management/crls/ebd3032d-728e-44d4-9914-d4f81c9972cb Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: trust_crls Additional Errors:

Show CRL Data for the Given CRL ID

Returns information about the specified CRL. For additional information,
include the ?details=true modifier at the end of the request URI.
Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/crls/<crl-id>
Request Headers:
n/a
Query Parameters:
GetCertParameter+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/crls/ebd3032d-728e-44d4-9914-d4f81c9972cb?details=true Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
Crl+

Example Response: { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "display_name": "igloo Certificate Authority", "resource_type": "crl", "pem_encoded": "-----BEGIN X509 CRL----------END X509 CRL-----\n", "details": { "next_update": "945220365000", "issuer": "1.2.840.113549.1.9.1=#161d726f6f744069676c6f6f2e6974732e756e696d656c622e6564752e6175,CN=igloo Certificate Authority,OU=Certificates Administration,O=igloo CA,L=Melbourne,ST=Victoria,C=AU", "version": "1" }, "_last_modified_user": "admin", "_last_modified_time": 1413387436438, "_create_time": 1413386249116, "_create_user": "admin" } Required Permissions: read Feature: trust_crls Additional Errors:

Update CRL for the Given CRL ID

Updates an existing CRL. Request:
Method:
PUT
URI Path:
/csmapi/api/v1/trust-management/crls/<crl-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
Crl+

Example Request: PUT https://<nsx-mgr>/api/v1/trust-management/crls/ebd3032d-728e-44d4-9914-d4f81c9972cb { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "display_name": "igloo Certificate Authority", "pem_encoded": "-----BEGIN X509 CRL----------END X509 CRL-----\n" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
Crl+

Example Response: { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "display_name": "igloo Certificate Authority", "resource_type": "crl", "pem_encoded": "-----BEGIN X509 CRL----------END X509 CRL-----\n", "_last_modified_time": 1413387436438, "_create_time": 1413386249116, "_create_user": "admin", "_last_modified_user": "admin" } Required Permissions: crud Feature: trust_crls Additional Errors:

Add a New Certificate Revocation List

Adds a new certificate revocation list (CRL). The CRL is used to verify the
client certificate status against the revocation lists published by the CA.
For this reason, the administrator needs to add the CRL in certificate
repository as well.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/crls?action=import
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CrlObjectData+

Example Request: POST https://<nsx-mgr>/api/v1/trust-management/crls?action=import { "pem_encoded": "-----BEGIN X509 CRL----------END X509 CRL-----\n" } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
CrlList+

Example Response: { "results": [ { "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "resource_type": "crl", "pem_encoded": "-----BEGIN X509 CRL----------END X509 CRL-----\n", "_last_modified_time": 1413386249116, "_create_time": 1413386249116, "_create_user": "admin", "_last_modified_user": "admin" } ] } Required Permissions: crud Feature: trust_crls Additional Errors:

Nsx Component Administration: Trust Management: Csr

Associated URIs:

Return All the Generated CSRs

Returns information about all of the CSRs that have been created. Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/csrs
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/csrs Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CsrList+

Example Response: { "result_count": 2, "results": [ { "id": "f1a858e1-fe70-41d0-a53b-32c43cec280f", "resource_type": "csr", "pem_encoded": "-----BEGIN CERTIFICATE REQUEST----------END CERTIFICATE REQUEST-----\n", "key_size": 2048, "subject": { "attributes": [ { "value": "Jane", "key": "CN" }, { "value": "VMware", "key": "O" }, { "value": "NSBU", "key": "OU" }, { "value": "US", "key": "C" }, { "value": "CA", "key": "ST" }, { "value": "PA", "key": "L" } ] }, "algorithm": "RSA", "_last_modified_time": 1413371717767, "_create_time": 1413371717767, "_create_user": "admin", "_last_modified_user": "admin" }, { "id": "351bf766-dcd3-477a-87bb-e72139f77396", "resource_type": "csr", "pem_encoded": "-----BEGIN CERTIFICATE REQUEST----------END CERTIFICATE REQUEST-----\n", "key_size": 2048, "subject": { "attributes": [ { "value": "Joe", "key": "CN" }, { "value": "VMware", "key": "O" }, { "value": "NSBU", "key": "OU" }, { "value": "US", "key": "C" }, { "value": "CA", "key": "ST" }, { "value": "PA", "key": "L" } ] }, "algorithm": "DSA", "_last_modified_time": 1413384517993, "_create_time": 1413384517993, "_create_user": "admin", "_last_modified_user": "admin" } ] } Required Permissions: read Feature: trust_csrs Additional Errors:

Generate a New Certificate Signing Request

Creates a new certificate signing request (CSR). A CSR is encrypted text that
contains information about your organization (organization name, country,
and so on) and your Web server's public key, which is a public certificate
the is generated on the server that can be used to forward this request to a
certificate authority (CA). A private key is also usually created at the
same time as the CSR.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/csrs
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
Csr+

Example Request: POST https://<nsx-mgr>/api/v1/trust-management/csrs { "subject": { "attributes": [ {"key":"CN","value":"Jane"}, {"key":"O","value":"VMware"}, {"key":"OU","value":"NSBU"}, {"key":"C","value":"US"}, {"key":"ST","value":"CA"}, {"key":"L","value":"PA"} ] }, "key_size": "2048", "algorithm": "RSA" } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
Csr+

Example Response: { "id": "f1a858e1-fe70-41d0-a53b-32c43cec280f", "resource_type": "csr", "pem_encoded": "-----BEGIN CERTIFICATE REQUEST----------END CERTIFICATE REQUEST-----\n", "key_size": 2048, "subject": { "attributes": [ { "value": "Jane", "key": "CN" }, { "value": "VMware", "key": "O" }, { "value": "NSBU", "key": "OU" }, { "value": "US", "key": "C" }, { "value": "CA", "key": "ST" }, { "value": "PA", "key": "L" } ] }, "algorithm": "RSA", "_last_modified_time": 1413371717767, "_create_time": 1413371717767, "_create_user": "admin", "_last_modified_user": "admin" } Required Permissions: crud Feature: trust_csrs Additional Errors:

Show CSR Data for the Given CSR ID

Returns information about the specified CSR. Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/csrs/<csr-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/csrs/170b0f6c-653b-4dcc-92bf-0ab8f3a00b08 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
Csr+

Example Response: { "id": "170b0f6c-653b-4dcc-92bf-0ab8f3a00b08", "resource_type": "csr", "pem_encoded": "-----BEGIN CERTIFICATE REQUEST----------END CERTIFICATE REQUEST-----\n", "key_size": 2048, "subject": { "attributes": [ { "value": "Jane", "key": "CN" }, { "value": "VMware", "key": "O" }, { "value": "NSBU", "key": "OU" }, { "value": "US", "key": "C" }, { "value": "CA", "key": "ST" }, { "value": "PA", "key": "L" } ] }, "algorithm": "RSA", "_last_modified_time": 1413382501591, "_create_time": 1413382501591, "_create_user": "admin", "_last_modified_user": "admin" } Required Permissions: read Feature: trust_csrs Additional Errors:

Delete a CSR

Removes a specified CSR. If a CSR is not used for verification, you can
delete it. Note that the CSR import and upload POST actions automatically
delete the associated CSR.
Request:
Method:
DELETE
URI Path:
/csmapi/api/v1/trust-management/csrs/<csr-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/trust-management/csrs/351bf766-dcd3-477a-87bb-e72139f77396 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Feature: trust_csrs Additional Errors:

Get CSR PEM File for the Given CSR ID

Downloads the CSR PEM file for a specified CSR. Clients must include an Accept: text/plain request header. Request:
Method:
GET
URI Path:
/csmapi/api/v1/trust-management/csrs/<csr-id>/pem-file
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/trust-management/csrs/f1a858e1-fe70-41d0-a53b-32c43cec280f/pem-file Accept: text/plain Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: text/plain;charset=UTF-8
Response Body:
string

Example Response: -----BEGIN CERTIFICATE REQUEST----------END CERTIFICATE REQUEST----- Required Permissions: read Feature: trust_csrs Additional Errors:

Import a Certificate Associated with an Approved CSR

Imports a certificate authority (CA)-signed certificate for a CSR. This
action links the certificate to the private key created by the CSR. The
pem_encoded string in the request body is the signed certificate provided by
your CA in response to the CSR that you provide to them. The import POST
action automatically deletes the associated CSR.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/csrs/<csr-id>?action=import
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
TrustObjectData+

Example Request: POST https://<nsx-mgr>/api/v1/trust-management/csrs/f1a858e1-fe70-41d0-a53b-32c43cec280f?action=import { "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n" } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
CertificateList+

Required Permissions: crud Feature: trust_csrs Additional Errors:

Self-Sign the CSR

Self-signs the previously generated CSR. This action is similar to the
import certificate action, but instead of using a public certificate signed
by a CA, the self_sign POST action uses a certificate that is signed with
NSX's own private key.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/csrs/<csr-id>?action=self_sign
Request Headers:
n/a
Query Parameters:
SelfSignedActionParameter+
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/trust-management/csrs/xxxx?action=self_sign "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n" Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
Certificate+

Example Response: { "id": "1b522350-832b-464b-9295-dff599dd5594", "resource_type": "certificate_self_signed", "pem_encoded": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----\n", "_last_modified_time": 1413382597133, "_create_time": 1413382597133, "_create_user": "admin", "_last_modified_user": "admin" } Required Permissions: crud Feature: trust_csrs Additional Errors:

Upload the Certificate PEM File Signed by the CA Associated with a CSR

Uploads the certificate authority (CA)-signed certificate. After you send
the certificate request to the CA of your choice, and the CA sends back the
signed certificate, you can use the upload POST action to upload the signed
certificate. The upload action is similar to the import action, but the
upload action allows you to directly upload the PEM-encoded file (signed
certificate) provided by the CA. Like the import POST action, the upload
POST action automatically deletes the associated CSR.
Request:
Method:
POST
URI Path:
/csmapi/api/v1/trust-management/csrs/<csr-id>?action=upload
Request Headers:
n/a
Query Parameters:
PemFile+
Request Body:
n/a

Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
CertificateList+

Required Permissions: crud Feature: trust_csrs Additional Errors:

Telemetryconfig

Associated URIs:

Set telemetry agreement information

Set telemetry agreement information. Request:
Method:
PUT
URI Path:
/csmapi/api/v1/telemetry/agreement
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
TelemetryAgreement+

Example Request: PUT https://<nsx-mgr>/api/v1/telemetry/agreement { "_revision": 4, "id": "TelemetryAgreementIdentifier", "resource_type": "TelemetryAgreement", "telemetry_agreement_displayed": true } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TelemetryAgreement+

Example Response: { "_revision": 5, "id": "TelemetryAgreementIdentifier", "display_name": "TelemetryAgreementIdentifier", "resource_type": "TelemetryAgreement", "_last_modified_user": "admin", "_last_modified_time": 1414620219999, "_create_time": 1414620218840, "_create_user": "admin", "telemetry_agreement_displayed": true } Required Permissions: crud Additional Errors:

Returns telemetry agreement information

Returns telemetry agreement information. Request:
Method:
GET
URI Path:
/csmapi/api/v1/telemetry/agreement
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/telemetry/agreement Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TelemetryAgreement+

Example Response: { "_revision": 4, "id": "TelemetryAgreementIdentifier", "display_name": "TelemetryAgreementIdentifier", "resource_type": "TelemetryAgreement", "_last_modified_user": "admin", "_last_modified_time": 1414620218840, "_create_time": 1414620218840, "_create_user": "admin", "telemetry_agreement_displayed": false } Required Permissions: read Additional Errors:

Returns the telemetry configuration

Returns the telemetry configuration. Request:
Method:
GET
URI Path:
/csmapi/api/v1/telemetry/config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/telemetry/config Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TelemetryConfig+

Example Response: { "ceip_acceptance" : true, "schedule_enabled" : true, "telemetry_schedule": { "frequency_type": "WeeklyTelemetrySchedule", "day_of_week": "MONDAY", "hour_of_day": 22 }, "proxy_enabled" : true, "telemetry_proxy": { "scheme": "HTTP", "hostname": "proxy.eng.vmware.com", "port": 8080, "username": "nsx_user" } } Required Permissions: read Additional Errors:

Creates or updates the telemetry configuration

Updates or creates the telemetry configuration, and returns the new configuration.
Request:
Method:
PUT
URI Path:
/csmapi/api/v1/telemetry/config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
TelemetryConfig+

Example Request: PUT https://<nsx-mgr>/api/v1/telemetry/config { "ceip_acceptance" : true, "schedule_enabled": true, "proxy_enabled": true, "telemetry_schedule": { "frequency_type": "DailyTelemetrySchedule", "hour_of_day": 10 }, "telemetry_proxy": { "scheme": "HTTP", "hostname": "proxy.eng.vmware.com", "port": 8080, "username": "nsx_user", "password": "password123" } } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TelemetryConfig+

Example Response: { "ceip_acceptance" : true, "schedule_enabled": true, "proxy_enabled": true, "telemetry_schedule": { "frequency_type": "DailyTelemetrySchedule", "hour_of_day": 10 }, "telemetry_proxy": { "scheme": "HTTP", "hostname": "proxy.eng.vmware.com", "port": 8080, "username": "nsx_user", "password": "password123" } } Required Permissions: crud Additional Errors:

Troubleshooting And Monitoring

Troubleshooting And Monitoring: System Logs

Associated URIs:

List available node logs

Returns the number of log files and lists the log files that reside on the
NSX virtual appliance. The list includes the filename, file size,
and last-modified time in milliseconds since epoch (1 January 1970) for each
log file. Knowing the last-modified time with millisecond accuracy since
epoch is helpful when you are comparing two times, such as the time of a
POST request and the end time on a server.
Request:
Method:
GET
URI Path:
/api/v1/node/logs
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/logs Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeLogPropertiesListResult+

Example Response: { "result_count": 70, "results": [ ... { "last_modified_time": 1442255851363, "log_name": "kern.log", "log_size": 175171 }, ... { "last_modified_time": 1442257962797, "log_name": "syslog", "log_size": 221701 }, ... ] } Required Permissions: read Feature: system_log Additional Errors:

Read node log properties

For a single specified log file, lists the filename, file size, and
last-modified time.
Request:
Method:
GET
URI Path:
/api/v1/node/logs/<log-name>
Request Headers:
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/logs/syslog Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Content-type: application/octet-stream
Response Body:
NodeLogProperties+

Example Response: { "last_modified_time": 1442258255032, "log_name": "syslog", "log_size": 224075 } Required Permissions: read Feature: system_log Additional Errors:

Read node log contents

For a single specified log file, returns the content of the log file.
This method supports byte-range requests. To request just a portion of a
log file, supply an HTTP Range header, e.g. "Range: bytes=-".
is optional, and, if omitted, the file contents from start to the
end of the file are returned.'
Request:
Method:
GET
URI Path:
/api/v1/node/logs/<log-name>/data
Request Headers:
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/node/logs/syslog/data Successful Response:
Response Code:
200 OK, 206 Partial Content
Response Headers:
FileRequestHeaders
Content-type: application/octet-stream
Response Body:
n/a

Example Response: 2015-09-14T19:35:23.688Z 10.160.30.117 NSX - - - UserName:'[email protected]', ModuleName:'ACCESS_CONTROL', Operation:'LOGIN', Operation status:'success' 2015-09-14T19:35:23.817Z nsx-manager NSX - - - "GET /api/v1/node/status HTTP/1.1" 200 2550 "" "" 0.123531 Required Permissions: read Feature: system_log Additional Errors:

Upgrade

Upgrade: Bundle

Associated URIs:

Upload upgrade bundle

Request:
Method:
POST
URI Path:
/api/v1/upgrade/bundle?action=upload
Request Headers:
n/a
Query Parameters:
UpgradeBundle+
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/bundle?action=upload Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Upgrade the upgrade coordinator.

Request:
Method:
POST
URI Path:
/api/v1/upgrade?action=upgrade_uc
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/upgrade?action=upgrade_uc Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Upgrade: Bundles

Associated URIs:

Fetch upgrade bundle from given url

Request:
Method:
POST
URI Path:
/api/v1/upgrade/bundles
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
UpgradeBundleFetchRequest+

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/bundles { "url" : "https://" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeBundleId+

Example Response: { "bundle_id" : "22000123456" } Required Permissions: crud Additional Errors:

Get uploaded upgrade bundle information

Get uploaded upgrade bundle information
Request:
Method:
GET
URI Path:
/api/v1/upgrade/bundles/<bundle-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/bundles/22000123456 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeBundleInfo+

Example Response: { "url" : "https://", "bundle_size" : "3622" } Required Permissions: read Additional Errors:

Get uploaded upgrade bundle upload status

Get uploaded upgrade bundle upload status
Request:
Method:
GET
URI Path:
/api/v1/upgrade/bundles/<bundle-id>/upload-status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/bundles/22000123456/upload-status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeBundleUploadStatus+

Example Response: { "url": "https://", "percent" : 100, "status" : "VERIFYING", "detailed_status": "Checking compatibility matrix of the Upgrade Bundle" } Required Permissions: read Additional Errors:

Upgrade: Group

Associated URIs:

Return information of all upgrade unit groups

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-unit-groups
Request Headers:
n/a
Query Parameters:
UpgradeUnitGroupListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups?component_type=HOST Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitGroupListResult+

Example Response: { "cursor" : "0036cd429462-4716-4ada-a66b-e4c78504a399nnuullll", "result_count" : 1, "results": [ { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts", "type": "HOST", "parallel": "false", "enabled": "true", "upgrade_unit_count": 2, "upgrade_units": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] } ], "extended_configuration": [ { "key": "disable_vm_migration", "value": "true" } ] } ] } Required Permissions: read Additional Errors:

Create a group

Request:
Method:
POST
URI Path:
/api/v1/upgrade/upgrade-unit-groups
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
UpgradeUnitGroup+

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups { "display_name": "esx55Hosts", "type": "HOST", "parallel": "false", "enabled": "true", "upgrade_units": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7" }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf" } ], "extended_configuration": [ { "key": "disable_vm_migration", "value": "true" } ] } Successful Response:
Response Code:
201 Created
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitGroup+

Example Response: { "resource_type": "UpgradeUnitGroup", "id": "e794562c-4d26-428a-9d19-9d79ddc4fb70", "display_name": "HostUpgrade", "upgrade_units": [ { "metadata": [ { "value": "ESXI", "key": "HYPERVISOR_OS" } ], "warnings": [], "current_version": "1.1.0.0.0.4788198", "id": "bf1c7b70-3709-11e7-9a39-fdf3dd0661a4", "display_name": "ESX 60 -2", "type": "HOST", "group": { "id": "e794562c-4d26-428a-9d19-9d79ddc4fb70", "display_name": "HostUpgrade" } } ], "extended_configuration": [ { "value": "true", "key": "disable_vm_migration" } ], "parallel": false, "type": "HOST", "enabled": true, "upgrade_unit_count": 1 } Required Permissions: crud Additional Errors:

Get upgrade status for upgrade unit groups

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-unit-groups-status
Request Headers:
n/a
Query Parameters:
ComponentTypeListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups-status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitGroupStatusListResult+

Example Response: { "cursor" : "0036cd429462-4716-4ada-a66b-e4c78504a399nnuullll", "result_count" : 3, "results": { [ { "group_id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "group_name": "esx55Hosts", "upgrade_unit_count": 10, "status": "SUCCESS", "failed_count": 0, "percent_complete": 100 }, { "group_id": "a60445eb-32aa-4782-bded-9b6ba99ba2cd", "group_name": "edgeGroup1", "upgrade_unit_count": 5, "status": "IN_PROGRESS", "failed_count": 0, "percent_complete": 40 }, { "group_id": "5346171c-1d77-401e-a2c4-9274b69cc342", "group_name": "ccpGroup1", "upgrade_unit_count": 2, "status": "NOT_STARTED", "failed_count": 0, "percent_complete": 0 } ] } } Required Permissions: read Additional Errors:

Update the upgrade unit group

Request:
Method:
PUT
URI Path:
/api/v1/upgrade/upgrade-unit-groups/<group-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
UpgradeUnitGroup+

Example Request: PUT https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5 { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55HostsGroup", "type": "HOST", "parallel": "true", "enabled": "false", "upgrade_units": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", } ], "extended_configuration": [ { "key": "disable_vm_migration", "value": "false" } ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitGroup+

Example Response: { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55HostsGroup", "type": "HOST", "parallel": "true", "enabled": "false", "upgrade_unit_count": 2, "upgrade_units": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] } ], "extended_configuration": [ { "key": "disable_vm_migration", "value": "false" } ] } Required Permissions: crud Additional Errors:

Return upgrade unit group information

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-unit-groups/<group-id>
Request Headers:
n/a
Query Parameters:
SummaryRequest+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitGroup+

Example Response: { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts", "type": "HOST", "parallel": "false", "enabled": "true", "upgrade_unit_count": 2, "upgrade_units": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] } ], "extended_configuration": [ { "key": "disable_vm_migration", "value": "true" } ] } Required Permissions: read Additional Errors:

Delete the upgrade unit group

Request:
Method:
DELETE
URI Path:
/api/v1/upgrade/upgrade-unit-groups/<group-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: DELETE https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5 Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Get upgrade status for group

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-unit-groups/<group-id>/status
Request Headers:
n/a
Query Parameters:
GroupStatusListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5/status Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitStatusListResult+

Example Response: { "cursor" : "0036c5a1531e-9145-4818-bdb3-cf299a6558a5nnuullll", "result_count" : 2, "results": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "status": "SUCCESS", "percent_complete": 100, "errors": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "status": "IN_PROGRESS", "percent_complete": 50, "errors": [] } ] } Required Permissions: read Additional Errors:

Reorder an upgrade unit within the upgrade unit group

Request:
Method:
POST
URI Path:
/api/v1/upgrade/upgrade-unit-groups/<group-id>/upgrade-unit/<upgrade-unit-id>?action=reorder
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ReorderRequest+

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5/upgrade-unit/1f64e9f4-eeb3-4ebd-af78-e08757e593cf?action=reorder { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "is_before": "false" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Add upgrade units to specified upgrade unit group

Request:
Method:
POST
URI Path:
/api/v1/upgrade/upgrade-unit-groups/<group-id>?action=add_upgrade_units
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
UpgradeUnitList+

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5?action=add_upgrade_units { "list": [ { "id": "e893085a-3709-11e7-ae6e-55850742a4d0", "group": { "display_name": "Two", "id": "ab1b2c01-97a6-44c6-b946-430728c0355d" } } ] } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitList+

Example Response: { "list": [ { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] } ] } Required Permissions: crud Additional Errors:

Reorder upgrade unit group

Request:
Method:
POST
URI Path:
/api/v1/upgrade/upgrade-unit-groups/<group-id>?action=reorder
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ReorderRequest+

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5?action=reorder { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "is_before": "false" } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Return aggregate information of all upgrade unit groups

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-unit-groups/aggregate-info
Request Headers:
n/a
Query Parameters:
UpgradeUnitGroupListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-unit-groups/aggregate-info Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitGroupAggregateInfoListResult+

Required Permissions: read Additional Errors:

Upgrade: History

Associated URIs:

Get upgrade history

Request:
Method:
GET
URI Path:
/api/v1/upgrade/history
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/history Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeHistoryList+

Example Response: { "results": { [ { "timestamp": "12569537329", "initial_version": "1.1.1.1213223", "target_version": "1.2.2.1819198" } ] } } Required Permissions: read Additional Errors:

Upgrade: Nodes

Associated URIs:

Get list of nodes across all types

Request:
Method:
GET
URI Path:
/api/v1/upgrade/nodes
Request Headers:
n/a
Query Parameters:
NodeInfoListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/nodes Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeInfoListResult+

Example Response: { "cursor" : "00017", "sort_ascending" : true, "result_count" : 7, "results" : [ { "id" : "15a71126-189c-11e7-9c28-9bba9532666d", "display_name" : "sc-rdops-vm05-dhcp-145-9.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "07cd4582-189c-11e7-b77f-7f1dfdccba5e", "display_name" : "sc-rdops-vm05-dhcp-158-121.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "25c9fd3e-189c-11e7-baa0-02001ae66268", "display_name" : "utu1604template.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "2fcfc200-189c-11e7-b5da-02001a173d3f", "display_name" : "utu1604template.eng.vmware.com", "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "id" : "4321711e-189c-11e7-8b13-000c29bbd840", "display_name" : "jane-nsxedge-ob-5292886-1-DK-Edge", "type" : "EDGE", "component_version" : "1.1.0.0.0.5292904" }, { "id" : "cae0232d-f99e-4bfa-acc7-805ed62e8701", "display_name" : "jane-nsxcontroller-ob-5292886-1-DK-Edge", "type" : "CCP", "component_version" : "1.1.0.0.0.5292902" }, { "id" : "421B38AA-E390-64B9-3FFF-7AD6EBF59C40", "display_name" : "jane-nsxmanager-ob-5292886-1-DK-Edge", "type" : "MP", "component_version" : "1.1.0.0.0.5292903" } ] } Required Permissions: read Additional Errors:

Get summary of nodes

Request:
Method:
GET
URI Path:
/api/v1/upgrade/nodes-summary
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/nodes-summary Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeSummaryList+

Example Response: { "results" : [ { "node_count" : 1, "type" : "CCP", "component_version" : "1.1.0.0.0.5292902" }, { "node_count" : 1, "type" : "MP", "component_version" : "1.1.0.0.0.5292903" }, { "node_count" : 4, "type" : "HOST", "component_version" : "1.1.0.0.0.5292922" }, { "node_count" : 1, "type" : "EDGE", "component_version" : "1.1.0.0.0.5292904" } ] } Required Permissions: read Additional Errors:

Get the version whitelist

Get whitelist of versions for different components Request:
Method:
GET
URI Path:
/csmapi/api/v1/upgrade/version-whitelist
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/version-whitelist Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AcceptableComponentVersionList+

Example Response: { "results": [ { "id": "MP", "display_name": "MP", "acceptable_versions": ["1.0.0.0.0.557878"], "component_type": "MP", "_last_modified_user": "admin", "_last_modified_time": 1435188284106, "_create_time": 1435015977176, "_create_user": "admin", "_revision": 0 }, { "id": "CCP", "display_name": "CCP", "acceptable_versions": ["1.0.0.0.0.543236"], "component_type": "CCP", "_last_modified_user": "admin", "_last_modified_time": 1435188284106, "_create_time": 1435015977176, "_create_user": "admin", "_revision": 0 }, { "id": "HOST", "display_name": "HOST", "acceptable_versions":["1.0.0.0.0.567876", "1.0.0.0.0.667576"], "component_type": "HOST", "_last_modified_user": "admin", "_last_modified_time": 1435188284106, "_create_time": 1435015977176, "_create_user": "admin", "_revision": 0 }, { "id": "EDGE", "display_name": "EDGE", "acceptable_versions": ["1.0.0.0.0.567876", "1.0.0.0.0.667576"], "component_type": "EDGE", "_last_modified_user": "admin", "_last_modified_time": 1435188284106, "_create_time": 1435015977176, "_create_user": "admin", "_revision": 0 } ] } Required Permissions: read Additional Errors:

Get the version whitelist for the specified component

Get whitelist of versions for a component. Component can include HOST, EDGE, CCP, MP Request:
Method:
GET
URI Path:
/csmapi/api/v1/upgrade/version-whitelist/<component_type>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/version-whitelist/HOST Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AcceptableComponentVersion+

Example Response: { "id": "HOST", "display_name": "HOST", "acceptable_versions": ["1.0.0.0.0.567876", "1.0.0.0.0.667576"], "component_type": "HOST", "_last_modified_user": "admin", "_last_modified_time": 1435188284106, "_create_time": 1435015977176, "_create_user": "admin", "_revision": 0 } Required Permissions: read Additional Errors:

Update the version whitelist for the specified component type

Update the version whitelist for the specified component type (HOST, EDGE, CCP, MP). Request:
Method:
PUT
URI Path:
/csmapi/api/v1/upgrade/version-whitelist/<component_type>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
VersionList+

Example Request: PUT https://<nsx-mgr>/api/v1/upgrade/version-whitelist/HOST { "acceptable_versions": ["1.0.0.0.0.557878","1.0.0.0.0.673278"], "_revision": 0 } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
n/a

Required Permissions: crud Additional Errors:

Upgrade: Plan

Associated URIs:

Update upgrade plan settings for the component

Update the upgrade plan settings for the component.
Request:
Method:
PUT
URI Path:
/api/v1/upgrade/plan/<component_type>/settings
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
UpgradePlanSettings+

Example Request: PUT https://<nsx-mgr>/api/v1/upgrade/plan/host/settings { "parallel" = "false", "pause_on_error" = "true", "pause_after_each_group" = "false" } Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradePlanSettings+

Example Response: { "parallel" = "false", "pause_on_error" = "true", "pause_after_each_group" = "false" } Required Permissions: crud Additional Errors:

Get upgrade plan settings for the component

Get the upgrade plan settings for the component.
Request:
Method:
GET
URI Path:
/api/v1/upgrade/plan/<component_type>/settings
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/plan/host/settings Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradePlanSettings+

Example Response: { "parallel" = "true", "pause_on_error" = "true", "pause_after_each_group" = "false" } Required Permissions: read Additional Errors:

Continue upgrade

Request:
Method:
POST
URI Path:
/api/v1/upgrade/plan?action=continue
Request Headers:
n/a
Query Parameters:
ContinueRequestParameters+
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/plan?action=continue Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Pause upgrade

Request:
Method:
POST
URI Path:
/api/v1/upgrade/plan?action=pause
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/plan?action=pause Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Reset upgrade plan to default plan

Reset the upgrade plan to default plan. User has an option to change
the default plan. But if after making changes, user wants to go
back to the default plan, this is the way to do so.
Request:
Method:
POST
URI Path:
/api/v1/upgrade/plan?action=reset
Request Headers:
n/a
Query Parameters:
UpgradePlanResetRequest+
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/plan?action=reset&component_type=HOST Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Start upgrade

Request:
Method:
POST
URI Path:
/api/v1/upgrade/plan?action=start
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/plan?action=start Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Upgrade selected units

Request:
Method:
POST
URI Path:
/api/v1/upgrade/plan?action=upgrade_selected_units
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
UpgradeUnitList+

Example Request: POST https://<nsx-mgr>/api/v1/upgrade/plan?action=upgrade_selected_units { "list": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7" }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf" }, { "id": "7f64e9f4-eeb3-4ebd-af78-e08757e593cf" } ] } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: crud Additional Errors:

Upgrade: Status

Associated URIs:

Get upgrade status summary

Request:
Method:
GET
URI Path:
/api/v1/upgrade/status-summary
Request Headers:
n/a
Query Parameters:
StatusSummaryRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/status-summary?component_type=EDGE&selection_status=ALL Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeStatus+

Example Response: { "host_status": { "status": "SUCCESS", "percent_complete": 100, "details": "All hosts upgraded successfully", "can_skip": false }, "edge_status": { "status": "IN_PROGRESS", "percent_complete": 40, "details": "Upgrade of edgeGroup1 in progress", "can_skip": false }, "ccp_status": { "status": "NOT_STARTED", "percent_complete": 0, "details": "Upgrade not started", "can_skip": false } "component_status": [{ "component_type": "EDGE", "status": "IN_PROGRESS", "percent_complete": 40, "details": "Upgrade of edgeGroup1 in progress", "can_skip": false } } Required Permissions: read Additional Errors:

Get upgrade summary

Request:
Method:
GET
URI Path:
/api/v1/upgrade/summary
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/summary Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeSummary+

Example Response: { "upgrade_status" : "PAUSED", "component_target_versions" : [ { "component_type" : "HOST", "target_version" : "2.0.0.0.0.5963423" }, { "component_type" : "EDGE", "target_version" : "2.0.0.0.0.5963333" }, { "component_type" : "CCP", "target_version" : "2.0.0.0.0.5963327" }, { "component_type" : "MP", "target_version" : "2.0.0.0.0.5963330" } ], "upgrade_coordinator_updated": true, "upgrade_coordinator_version" : "1.2.3.0.0.456789", "system_version" : "1.1.0.0.0.4787411", "target_version" : "2.0.0.0.0.5963330", "upgrade_bundle_file_name" : "VMware-NSX-upgrade-bundle-2.0.0.0.0.5963330.mub" } Required Permissions: read Additional Errors:

Upgrade: Upgradeunits

Associated URIs:

Get upgrade units

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-units
Request Headers:
n/a
Query Parameters:
UpgradeUnitListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-units Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitListResult+

Example Response: { "cursor" : "0036cd429462-4716-4ada-a66b-e4c78504a399nnuullll", "result_count" : 4, "results": [ { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] }, { "id": "1f64e9f4-eeb3-4ebd-af78-e08757e593cf", "display_name": "esx552", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] }, { "id": "aa1e9a33-3bd3-4fbb-92b1-00db2cd7fb2f", "display_name": "euu1", "type": "EDGE", "current_version": "1.0.0.2333378", "group": { "id": "a60445eb-32aa-4782-bded-9b6ba99ba2cd", "display_name": "egroup1" }, "warnings": [], "metadata": [] }, { "id": "b2f3f702-99bb-4577-b209-1c30eeba9fca", "display_name": "cuu1", "type": "CCP", "current_version": "1.0.0.7766956", "group": { "id": "5346171c-1d77-401e-a2c4-9274b69cc342", "display_name": "cgroup1" }, "warnings": [], "metadata": [] } ] } Required Permissions: read Additional Errors:

Get upgrade units stats

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-units-stats
Request Headers:
n/a
Query Parameters:
UpgradeUnitsStatsRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-units-stats?sync=false Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitTypeStatsList+

Example Response: { "results": { [ { "type": "HOST", "version": "1.1.1.4245555", "node_count": 10, "node_with_issues_count": 0 }, { "type": "EDGE", "version": "1.1.1.1213223", "node_count": 2, "node_with_issues_count": 0 }, { "type": "CCP", "version": "1.1.1.1433223", "node_count": 2, "node_with_issues_count": 1 }, ] } } Required Permissions: read Additional Errors:

Get a specific upgrade unit

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-units/<upgrade-unit-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-units/a95be8d6-4a76-46fe-9c9c-341e89973da7 Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnit+

Example Response: { "id": "a95be8d6-4a76-46fe-9c9c-341e89973da7", "display_name": "esx551", "type": "HOST", "current_version": "1.0.0.1444456", "group": { "id": "d00d6a39-5ff2-4ddc-a63f-672b4e9ecc5", "display_name": "esx55Hosts" }, "warnings": [], "metadata": [] } Required Permissions: read Additional Errors:

Get upgrade units aggregate-info

Request:
Method:
GET
URI Path:
/api/v1/upgrade/upgrade-units/aggregate-info
Request Headers:
n/a
Query Parameters:
UpgradeUnitAggregateInfoListRequestParameters+
Request Body:
n/a

Example Request: GET https://<nsx-mgr>/api/v1/upgrade/upgrade-units/aggregate-info Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitAggregateInfoListResult+

Example Response: { "cursor" : "00011", "sort_ascending" : true, "result_count" : 1, "results" : [ { "warnings" : [ ], "current_version" : "1.1.0.0.0.5292903", "id" : "421B38AA-E390-64B9-3FFF-7AD6EBF59C40", "display_name" : "jane-nsxmanager-ob-5292886-1-DK-Edge", "type" : "MP", "percent_complete" : 0.0, "errors" : [ ], "group" : { "id" : "4c0486b8-1575-4aa6-aa62-1ac50879467a", "display_name" : "MPUpgradeGroup" }, "status" : "NOT_STARTED" } ] } Required Permissions: read Additional Errors:


API Types


ALGTypeNSService (schema)

An NSService element that represents an ALG protocol

Name Description Type Notes
alg The Application Layer Gateway (ALG) protocol string Required
Enum: ORACLE_TNS, FTP, SUN_RPC_TCP, SUN_RPC_UDP, MS_RPC_TCP, MS_RPC_UDP, NBNS_BROADCAST, NBDG_BROADCAST, TFTP
destination_ports The destination_port cannot be empty and must be a single value. array of PortElement Maximum items: 15
resource_type Must be set to the value ALGTypeNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService
source_ports Source ports array of PortElement Maximum items: 15

AcceptableComponentVersion (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
acceptable_versions List of component versions array of string Required
component_type Node type string Required
Enum: HOST, EDGE, CCP, MP
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value AcceptableComponentVersion string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AcceptableComponentVersionList (schema)

Name Description Type Notes
results Acceptable version whitelist for different components array of AcceptableComponentVersion Required

ActionableResource (schema)

Resources managed during restore process

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
ip_address A resource reference on which actions can be performed IPAddress
resource_type Must be set to the value ActionableResource string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ActionableResourceListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
instruction_id Id of the instruction set whose instructions are to be returned string Required
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

ActionableResourceListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List results array of ActionableResource Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AddClusterNodeAction (schema)

Name Description Type Notes
action string Required
Enum: add_cluster_node

AddClusterNodeSpec (schema)

Name Description Type Notes
controller_role_config AddControllerNodeSpec
display_name Display name for the node string
external_id External identifier of the node string
mgr_role_config AddManagementNodeSpec

AddControllerNodeSpec (schema)

Name Description Type Notes
clustering_params Clustering parameters for the node

The details of the controller node required for cluster initialization or joining to an existing cluster. If this property is set, the node will be added to an existing cluster or used to create a new cluster. Otherwise no clustering operation/s will be performed.		 ClusteringInfo
control_plane_server_certificate Deprecated. Do not supply a value for this property. string Deprecated
host_msg_client_info MsgClientInfo Required
mpa_msg_client_info MsgClientInfo Required
node_id Internal identifier of the node

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.		 string
type must be set to AddControllerNodeSpec string Required
Enum: AddControllerNodeSpec

AddManagementNodeSpec (schema)

Name Description Type Notes
cert_thumbprint The certificate thumbprint of the remote node. string
mpa_msg_client_info MsgClientInfo
password The password to be used to authenticate with the remote node. string Required
remote_address The host address of the remote node to which to send this join request. IPAddress Required
type must be set to AddManagementNodeSpec string Required
Enum: AddManagementNodeSpec
user_name The username to be used to authenticate with the remote node. string Required

AddressFamilyType (schema)

Type of Address Family

Name Description Type Notes
AddressFamilyType Type of Address Family string Enum: IPV4_UNICAST, VPNV4_UNICAST

AdvanceClusterRestoreInput (schema)

Name Description Type Notes
id Unique id of an instruction (as returned by the GET /restore/status call) for which input is to be provided string Required
Readonly
resources List of resources for which the instruction is applicable. array of SelectableResourceReference Required

AdvanceClusterRestoreRequest (schema)

Name Description Type Notes
data List of instructions and their associated data array of AdvanceClusterRestoreInput Required

AdvertiseRule (schema)

Name Description Type Notes
action Action to ALLOW or DENY advertisement of routes

ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.		 string Enum: DENY, ALLOW
Default: "ALLOW"
description Description string Maximum length: 1024
display_name Display name string Maximum length: 255
networks network(CIDR) to be routed array of IPv4CIDRBlock Required
rule_filter Rule filter for the advertise rule AdvertisementRuleFilter

AdvertiseRuleList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value AdvertiseRuleList string
rules List of advertisement rules array of AdvertiseRule Minimum items: 0
Default: "[]"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AdvertisedNetwork (schema)

Name Description Type Notes
advertised_route_type Advertised route type of network

Advertise network route type on TIER0 LR		 string Readonly
is_advertised Advertisement status of network

Flag to denote advertisement status of network to TIER0 LR.		 boolean Readonly
Default: "False"
network Advertised Network

Advertised network address.		 IPv4Address Required
Readonly
resource Resource of network

Resource which has registered network.		 ResourceReference Required
Readonly

AdvertisedNetworksListParameters (schema)

Advertised networks list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

AdvertisedNetworksListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of advertised networks

List of networks which advertised to TIER0 from TIER1 LR		 array of AdvertisedNetwork Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AdvertisementConfig (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
advertise_lb_snat_ip Flag to advertise all lb SNAT ips boolean Default: "False"
advertise_lb_vip Flag to advertise lb vip boolean Default: "False"
advertise_nat_routes Flag to advertise all routes of nat boolean Default: "False"
advertise_nsx_connected_routes Flag to advertise all connected routes boolean Default: "False"
advertise_static_routes Flag to advertise all static routes boolean Default: "False"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Flag to enable this configuration boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value AdvertisementConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AdvertisementRuleFilter (schema)

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.

Name Description Type Notes
match_route_types Array of route types to filter routes array of AdvertisementRuleFilterRouteType Required
Minimum items: 1
prefix_operator Prefix operator to apply on networks

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.		 string Required
Enum: GE, EQ
Default: "GE"

AdvertisementRuleFilterRouteType (schema)

Route types to filter the routes advertised by TIER1 LR. The ANY type filters all routes advertised by TIER1. The STATIC type filters STATIC routes advertised by TIER1. The NSX_CONNECTED type filters routes conrresponding to downlink 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 correspoding to LB SNAT rules advertised by TIER1.

Name Description Type Notes
AdvertisementRuleFilterRouteType Route types to filter the routes advertised by TIER1 LR. The ANY type filters all routes advertised by TIER1. The STATIC type filters STATIC routes advertised by TIER1. The NSX_CONNECTED type filters routes conrresponding to downlink 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 correspoding to LB SNAT rules advertised by TIER1. string Enum: ANY, STATIC, NSX_CONNECTED, T1_NAT, T1_LB_VIP, T1_LB_SNAT

AgentInfo (schema)

Agent Information

Information on agent download link and install command.

Name Description Type Notes
agent_download_link Link to Download Agent string
agent_install_command Command to Install Agent string
agent_os_type Agent OS Type string

AggregateDataResponse (schema)

Data aggregation response

Final data aggregation response.
The results array holds the primary and the related objects

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array containing the primary and the related object details		 array of AggregateResponse Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AggregateRequest (schema)

Aggregate request

Common request parameters for the primary/related types

Name Description Type Notes
alias Alias

Alias for the response		 string
filters Filter conditions

An array of filter conditions		 array of FilterRequest
included_fields Comma separated list of fields that should be included in query result string
resource_type Resource Type

Resource type name		 string Required

AggregateResponse (schema)

Aggregate response

Response for the primary/related types

Name Description Type Notes
primary Primary object properties

Requested properties of the primary object		 object Required
related Related objects properties

Requested properties of the related objects		 array of RelatedData Required

Alarm (schema)

Alarm in NSX that needs users' attention

Name Description Type Notes
id Unique identifier for an NSX Alarm string Required
Readonly
severity Severity of an Alarm string Required
Readonly
Enum: UNKNOWN, MINOR, MAJOR, CRITICAL
source_comp Alarm source component like nsx-manager, nsx-edge etc string Required
Readonly
source_comp_id Unique identifier(like UUID) for the node sending the Alarm string Required
Readonly
source_subcomp Alarm source sub component like nsx-mpa etc string Required
Readonly
sources Sources emitting this alarm array of AlarmSource Readonly
state Alarm state Required
Enum: UNKNOWN, ACTIVE, ACKNOWLEDGED, RESOLVED
timestamp Date and time in UTC of the Alarm EpochMsTimestamp Required
Readonly

AlarmListResult (schema)

Alarm collection results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Alarm results array of Alarm Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AlarmQueryParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page)

A log cursor points to a specific line number in the alarm list		 integer
fields Fields to include in query results

Comma-separated field names to include in query result		 string
page_size Maximum number of results to return in this page (server may return fewer)

The page size determines the number of alarms to be returned		 integer Minimum: 0
Maximum: 100
Default: "100"

AlarmSource (schema)

Source of the Alarm

Name Description Type Notes
id Identifier of the Alarm source entity for e.g. Vpn session id, Vpn tunnel id etc. string Readonly
ip_address Ip address string Readonly
ip_address_type Ip address type v4, v6 etc. Readonly
Enum: IPV4, IPV6
local_ip VPN session/tunnel etc. local Ip(v4 or v6) address string Readonly
mount Filesystem mount name string Readonly
peer_ip VPN session/tunnel etc. peer Ip(v4 or v6) address string Readonly

AllAccountsStateInfo (schema)

State Information Of All Accounts

State Information of all accounts like synchronization in progress count.

Name Description Type Notes
sync_in_progress Sync In Progress Count

Number of cloud accounts for which inventory synchronization is in progress.
integer Readonly

AllAccountsStatistics (schema)

All Accounts Statistics

Stores statistics of all accounts managed by CSM.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
accounts_count Accounts Count

Count of the all accounts managed by CSM.		 integer Readonly
accounts_status Status Of All Accounts

Status of all accounts like synchronization in progress count.		 AllAccountsStateInfo Readonly
instance_stats Instance Statistics

Instance statistics accross all accounts managed by CSM.
InstanceStats Readonly
resource_type Resource Type

Optional identifier for listing all accounts statistics of a particular cloud
provider. Legal values are AwsAccount or AzureAccount.
string Enum: AwsAccount, AzureAccount

AllAccountsStatisticsListResult (schema)

All Accounts Statistics List Result

Stores statistics for all accounts managed by CSM.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results array of AllAccountsStatistics
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AllAccountsStatisticsRequestParameters (schema)

All Accounts Statistics Request Parameters

A set of optional filter paramters to list all accounts statistics.

Name Description Type Notes
cloud_type Cloud Type

Optional identifier for cloud provider based on which all accounts
statistics are to be filtered. Legal values are AWS or AZURE.
string Enum: AWS, AZURE
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_type Resource Type

Optional identifier for listing all accounts statistics of a particular cloud
provider. Legal values are AwsAccount or AzureAccount.
string Enum: AwsAccount, AzureAccount
sort_ascending boolean
sort_by Field by which records are sorted string

AllAwsAccountsStatistics (schema)

All AWS Accounts Statistics

Stores statistics of all AWS accounts.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
accounts_count Accounts Count

Count of the all accounts managed by CSM.		 integer Readonly
accounts_status Status Of All Accounts

Status of all accounts like synchronization in progress count.		 AllAccountsStateInfo Readonly
instance_stats Instance Statistics

Instance statistics accross all accounts managed by CSM.
InstanceStats Readonly
regions_count AWS Regions Count

Count of the regions accessible.		 integer Readonly
resource_type Resource Type

Optional identifier for listing all accounts statistics of a particular cloud
provider. Legal values are AwsAccount or AzureAccount.
string Enum: AwsAccount, AzureAccount
vpc_stats VPC statistics VpcStats Readonly

AllAzureAccountsStatistics (schema)

All Azure Accounts Statistics

Stores statistics of all Azure accounts.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
accounts_count Accounts Count

Count of the all accounts managed by CSM.		 integer Readonly
accounts_status Status Of All Accounts

Status of all accounts like synchronization in progress count.		 AllAccountsStateInfo Readonly
instance_stats Instance Statistics

Instance statistics accross all accounts managed by CSM.
InstanceStats Readonly
regions_count Azure Regions Count

Count of the regions accessible.		 integer Readonly
resource_type Resource Type

Optional identifier for listing all accounts statistics of a particular cloud
provider. Legal values are AwsAccount or AzureAccount.
string Enum: AwsAccount, AzureAccount
vnet_stats Virtual Network Statistics

Virtual network statistics accross all Azure accounts managed by CSM.
VnetStats Readonly

AllClusterGroupStatus (schema)

Status of all the cluster groups

A list of the statuses of all the groups in the cluster.

Name Description Type Notes
cluster_id UUID of the cluster string Readonly
groups Array of groups and their statuses array of ClusterGroupStatus Readonly

AllocationIpAddress (schema)

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
allocation_id Address that is allocated from pool IPAddress Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value AllocationIpAddress string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AllocationIpAddressListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Pool allocation list results array of AllocationIpAddress Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AllocationPoolType (schema)

Types of logical router allocation pool based on services

Name Description Type Notes
AllocationPoolType Types of logical router allocation pool based on services string Enum: LoadBalancerAllocationPool

ApiError (schema)

Detailed information about an API Error

Name Description Type Notes
details Further details about the error string
error_code A numeric error code integer
error_data Additional data about the error object
error_message A description of the error string
module_name The module name where the error occurred string
related_errors Other errors related to this error array of RelatedApiError

AppDiscoveryAppProfileResultSummary (schema)

Application discovery result summary of an App Profile

Contains the application discovery result summary of the App Profile

Name Description Type Notes
app_profile_id ID of the App Profile string
display_name Name of the App Profile string
installed_apps_count Number of apps installed that belongs to this App Profile integer

AppDiscoverySession (schema)

Contains the details of an application discovery session

Contains the details of an application discovery session

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
end_timestamp End time of the session expressed in milliseconds since epoch EpochMsTimestamp
failed_reason The reason for the session status failure. string Readonly
id Unique identifier of this resource string Readonly
Sortable
reclassification The reclassification status of the discovery session

Some App Profiles that were part of the discovery session could be modified or deleted |
after the session has been completed. NOT_REQUIRED status denotes that there were no such modifications. |
REQUIRED status denotes some App Profiles that were part of the session has been modified/deleted and some |
and some applications might not have been classfifed correctly. Use /session//reclassify API to|
re-classfy the applications discovered based on app profiles.
string Readonly
Enum: NOT_REQUIRED, REQUIRED
resource_type Must be set to the value AppDiscoverySession string
start_timestamp Start time of the session expressed in milliseconds since epoch EpochMsTimestamp
status The status of the session string Readonly
Enum: FAILED, RUNNING, FINISHED
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AppDiscoverySessionResultSummary (schema)

Contains the summary of the results of an application discovery session

Contains the summary of the results of an application discovery session

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
app_profile_summary_list List of App Profiles summary discovered in this session array of AppDiscoveryAppProfileResultSummary
app_profiles List of app profiles targeted to be classified for this session array of AppProfileMetaInfo
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
end_timestamp End time of the session expressed in milliseconds since epoch EpochMsTimestamp
failed_reason The reason for the session status failure. string Readonly
id Unique identifier of this resource string Readonly
Sortable
ns_groups List of NSGroups provided for discovery for this session array of NSGroupMetaInfo
reclassification The reclassification status of the discovery session

Some App Profiles that were part of the discovery session could be modified or deleted |
after the session has been completed. NOT_REQUIRED status denotes that there were no such modifications. |
REQUIRED status denotes some App Profiles that were part of the session has been modified/deleted and some |
and some applications might not have been classfifed correctly. Use /session//reclassify API to|
re-classfy the applications discovered based on app profiles.
string Readonly
Enum: NOT_REQUIRED, REQUIRED
resource_type Must be set to the value AppDiscoverySessionResultSummary string
start_timestamp Start time of the session expressed in milliseconds since epoch EpochMsTimestamp
status The status of the session string Readonly
Enum: FAILED, RUNNING, FINISHED
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AppDiscoverySessionsListResult (schema)

Application discovery sessions list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results AppProfile Sessions results array of AppDiscoverySession Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AppDiscoverySessionsParameters (schema)

Parameters to query session with, such as nsgroup id

Parameters to query application discovery sessions with.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
group_id NSGroup id, helps user query sessions related to one nsgroup string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
status Session Status, e.g. get all running sessions string Enum: STARTING, FAILED, RUNNING, FINISHED

AppDiscoveryVmInfo (schema)

AppDiscoveryVmInfo details

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
os_properties OS properties of the VM array of string
os_type OS type of the VM string Enum: INVALID, WINDOWS, LINUX
vm_external_id External Id of the VM string
vm_name Name of the VM string

AppDiscoveryVmInfoListResult (schema)

AppDiscoveryVmInfo list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results list of AppDiscoveryVmInfos array of AppDiscoveryVmInfo Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AppInfo (schema)

AppInfo details

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
manufacturer Manufacturer of the app string
name Name of the app string
os_type OS type of VM the App belongs to string Enum: INVALID, WINDOWS, LINUX
resource_type Must be set to the value AppInfo string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
version Version of the app string
vm_ids Ids of the VMs in which this app is installed array of string

AppInfoHostVmCsvRecord (schema)

Name Description Type Notes
display_name Name of the app string Readonly
host_vms vm ids that this application belongs to string Readonly
id Id of the app string Readonly
manufacturer Manufacturer of the app string Readonly
os_type OS type of the VM string Enum: INVALID, WINDOWS, LINUX
version Version of the app string Readonly

AppInfoHostVmListInCsvFormat (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
results List of appplications discovered during an application discovery session array of AppInfoHostVmCsvRecord

AppInfoListResult (schema)

AppInfo Sessions list results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Application details corresponding to the App Profile array of AppInfo Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AppProfile (schema)

AppProfile details

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
app_profile_category Category of the app profile, value could be any string that describes the profile string
app_profile_criteria Criteria of the app profile, value could be any string or "*" (match any string) array of string Required
default_app_profile True if this App Profile is a default profile (automatically created by the system) boolean
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value AppProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AppProfileListRequestParameters (schema)

Parameters to query app profiles with

Parameters to query app profiles with.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

AppProfileListResult (schema)

App Profile ID list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results AppProfile IDs array of AppProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AppProfileMemberAppsCsvRecord (schema)

Name Description Type Notes
app_profile_category Category of the app profile, value could be any string that describes the profile string Readonly
app_profile_criteria Criteria of the app profile, value could be any string or "*" (match any string) string Readonly
description Description of the app profile string Readonly
display_name Name of the app profile string Readonly
member_apps Applications that are member of this app profile string Readonly

AppProfileMemberAppsListInCsvFormat (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
results List of app profiles for an application discovery session array of AppProfileMemberAppsCsvRecord

AppProfileMetaInfo (schema)

Metadata about App Profile

Contains the metadata of an App Profile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
app_profile_category Categories of the app profile string
app_profile_id ID of the App Profile string
app_profile_name Name of the App Profile string
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value AppProfileMetaInfo string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ApplianceManagementSuppressRedirectQueryParameter (schema)

Name Description Type Notes
suppress_redirect Suppress redirect status if applicable

Do not return a redirect HTTP status.		 boolean Default: "False"

ApplianceManagementTaskListResult (schema)

Appliance management task query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Task property results array of ApplianceManagementTaskProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ApplianceManagementTaskProperties (schema)

Appliance management task properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
async_response_available True if response for asynchronous request is available boolean Readonly
cancelable True if this task can be canceled boolean Readonly
description Description of the task string Readonly
details Details about the task if known object Readonly
end_time The end time of the task in epoch milliseconds EpochMsTimestamp Readonly
id Identifier for this task string Readonly
Pattern: "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
message A message describing the disposition of the task string Readonly
progress Task progress if known, from 0 to 100 integer Readonly
Minimum: 0
Maximum: 100
request_method HTTP request method string Readonly
request_uri URI of the method invocation that spawned this task string Readonly
start_time The start time of the task in epoch milliseconds EpochMsTimestamp Readonly
status Current status of the task ApplianceManagementTaskStatus Readonly
user Name of the user who created this task string Readonly

ApplianceManagementTaskQueryParameters (schema)

Name Description Type Notes
fields Fields to include in query results

Comma-separated field names to include in query result		 string
request_method Request method(s) to include in query result

Comma-separated request methods to include in query result		 string Pattern: "^(=|!=|~|!~)?.+$"
request_path Request URI path(s) to include in query result

Comma-separated request paths to include in query result		 string Pattern: "^(=|!=|~|!~)?.+$"
request_uri Request URI(s) to include in query result

Comma-separated request URIs to include in query result		 string Pattern: "^(=|!=|~|!~)?.+$"
status Status(es) to include in query result

Comma-separated status values to include in query result		 string Pattern: "^(=|!=|~|!~)?.+$"
user Names of users to include in query result

Comma-separated user names to include in query result		 string Pattern: "^(=|!=|~|!~)?.+$"

ApplianceManagementTaskStatus (schema)

Current status of the appliance management task

Name Description Type Notes
ApplianceManagementTaskStatus Current status of the appliance management task string Enum: running, error, success, canceling, canceled, killed

ApplicationProfileType (schema)

application profile type

An application profile can be bound to a virtual server
to specify the application protocol characteristics. It is used to
influence how load balancing is performed. Currently, three types of
application profiles are supported: LbFastTCPProfile,
LbFastUDPProfile and LbHttpProfile.
LbFastTCPProfile or LbFastUDPProfile is typically
used when the application is using a custom protocol or a standard protocol
not supported by the load balancer. It is also used in cases where the user
only wants L4 load balancing mainly because L4 load balancing has much
higher performance and scalability, and/or supports connection mirroring.
LbHttpProfile is used for both HTTP and HTTPS applications.
Though application rules, if bound to the virtual server, can be used
to accomplish the same goal, LbHttpProfile is intended to
simplify enabling certain common use cases.

Name Description Type Notes
ApplicationProfileType application profile type

An application profile can be bound to a virtual server
to specify the application protocol characteristics. It is used to
influence how load balancing is performed. Currently, three types of
application profiles are supported: LbFastTCPProfile,
LbFastUDPProfile and LbHttpProfile.
LbFastTCPProfile or LbFastUDPProfile is typically
used when the application is using a custom protocol or a standard protocol
not supported by the load balancer. It is also used in cases where the user
only wants L4 load balancing mainly because L4 load balancing has much
higher performance and scalability, and/or supports connection mirroring.
LbHttpProfile is used for both HTTP and HTTPS applications.
Though application rules, if bound to the virtual server, can be used
to accomplish the same goal, LbHttpProfile is intended to
simplify enabling certain common use cases.
string Enum: LbHttpProfile, LbFastTcpProfile, LbFastUdpProfile

AppliedTos (schema)

Entities Applied to Profile

Entity lists where the profile will be enabled on.

Name Description Type Notes
logical_ports Logical Port List array of ResourceReference
logical_switches Logical Switch List array of ResourceReference
nsgroups NSGroup List array of ResourceReference

AssignedByDhcp (schema)

DHCP based IP assignment.

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.

Name Description Type Notes
resource_type Must be set to the value AssignedByDhcp string Required
Enum: StaticIpPoolSpec, StaticIpListSpec, AssignedByDhcp, StaticIpMacListSpec

AssociationListRequestParameters (schema)

Association list request parameters

Name Description Type Notes
associated_resource_type Type of the associated resources AssociationTargetType Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
fetch_ancestors Fetch complete list of associated resources considering containment and nesting

If set to true, will fetch direct as well as
indirect(considering containment as well as nesting)
associated objects for the given source Id.
boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_id The resource for which associated resources are to be fetched string Required
resource_type Type of the resource for which associated resources are to be fetched AssociationSourceType Required
sort_ascending boolean
sort_by Field by which records are sorted string

AssociationListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged Collection of ResourceReference array of ResourceReference Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AssociationSourceType (schema)

Resource type valid for use as source in association API

Name Description Type Notes
AssociationSourceType Resource type valid for use as source in association API string Enum: NSGroup, IPSet, MACSet, LogicalSwitch, LogicalPort, VirtualMachine, DirectoryGroup

AssociationTargetType (schema)

Resource type valid for use as target in association API

Name Description Type Notes
AssociationTargetType Resource type valid for use as target in association API string Enum: NSGroup

AttachmentContext (schema)

This is an abstract type. Concrete child types:
L2VpnAttachmentContext
VifAttachmentContext

Name Description Type Notes
allocate_addresses A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch. string Enum: IpPool, MacPool, Both, None
resource_type Used to identify which concrete class it is string Required

AttachmentType (schema)

Type of attachment for logical port.

Name Description Type Notes
AttachmentType Type of attachment for logical port. string Enum: VIF, LOGICALROUTER, BRIDGEENDPOINT, DHCP_SERVICE, METADATA_PROXY, L2VPN_SESSION

AttachmentTypeQueryString (schema)

Type of attachment for logical port; for query only.

Name Description Type Notes
AttachmentTypeQueryString Type of attachment for logical port; for query only. string Enum: VIF, LOGICALROUTER, BRIDGEENDPOINT, DHCP_SERVICE, METADATA_PROXY, L2VPN_SESSION, NONE

Attribute (schema)

Attributes

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.

Name Description Type Notes
attribute_type Attributetype.

Attribute Type can be of any of the allowed enum type.		 string Enum: IP_ADDRESS, PORT, PASSWORD, STRING, LONG
display_name Display name

Attribute display name string value.		 string
key key

Attribute key string value.		 string
value value

Attribute value string value.		 string

AuditLog (schema)

Audit log in RFC5424 format

Name Description Type Notes
appname Application name field of the log string Required
facility Facility field of the log integer Required
full_log Full log with both header and message string Required
hostname Hostname field of the log string Required
message Message field of the log string Required
msgid Message ID field of the log string Required
priority Priority field of the log integer Required
procid Process ID field of the log integer Required
struct_data Structured data field of the log StructuredData Required
timestamp Date and time in UTC of the log string Required

AuditLogListResult (schema)

Audit log collection results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_full_sync_timestamp Timestamp of the last full audit log collection string Required
result_count Count of results found (across all pages), set only on first page integer Readonly
results Audit log results array of AuditLog Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AuditLogQueryParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page)

A log cursor points to a specific line number in the master audit log		 integer
fields Fields to include in query results

Comma-separated field names to include in query result		 string
page_size Maximum number of results to return in this page (server may return fewer)

The page size determines the number of logs to be returned		 integer Minimum: 0
Maximum: 100
Default: "100"

AuditLogRequest (schema)

Name Description Type Notes
log_age_limit Include logs with timstamps not past the age limit in days integer Minimum: 0
log_filter Audit logs should meet the filter condition string
log_filter_type Type of log filter string Enum: TEXT, REGEX
Default: "TEXT"

AuthenticationPolicyProperties (schema)

Configuration of authentication policies for the NSX node

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
api_failed_auth_lockout_period Lockout period in seconds

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.		 integer Minimum: 0
Default: "900"
api_failed_auth_reset_period Period, in seconds, for authentication failures to trigger lockout

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.		 integer Minimum: 0
Default: "900"
api_max_auth_failures Number of authentication failures that trigger API lockout

Only applies to NSX Manager nodes. Ignored on other node types.		 integer Minimum: 0
Default: "5"
cli_failed_auth_lockout_period Lockout period in seconds

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.		 integer Minimum: 0
Default: "900"
cli_max_auth_failures Number of authentication failures that trigger CLI lockout integer Minimum: 0
Default: "5"
minimum_password_length Minimum number of characters required in account passwords integer Minimum: 8
Default: "8"

AuthenticationScheme (schema)

Name Description Type Notes
scheme_name Authentication scheme name string Required

AwsAccount (schema)

AWS account

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
access_key Access key of cloud account

This field is DEPRECATED. Please use the field credentials.		 string Deprecated
auth_mechanism_iam Is the AWS authorization mechanism based on Identity and Access Management(IAM) service?

This field is DEPRECATED. Please use the field auth_method.		 boolean Deprecated
auth_method AWS account authorization method

This property conveys the authorization method to use. Appropriate
credentials/parameters will be expected based on this method selection.
string Readonly
Enum: CREDENTIALS
auth_users Authrized Users

List of authorized users.		 array of CloudUserInfo Readonly
cloud_tags_enabled Boolean flag to enable or disable cloud tags discovery

Boolean flag to enable or disable cloud tags discovery. The discovered
cloud tags can be used to define security group membership.
boolean Default: "True"
cloud_type Cloud Type string Required
Enum: AWS, AZURE, GOOGLE
credentials AWS Credentials

Credentials of AWS Account.		 AwsCredentials Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id External id for the IAM role csm needs to assume

This field is DEPRECATED. Please use the field credentials.		 string Deprecated
gateway_role_name Gateway Role Name

This field is DEPRECATED. Please use the field credentials.
string Deprecated
has_managed_vpc Has a managed VPC?

This field is DEPRECATED. Please use vpc_stats to get the number of
managed VPCs.
boolean Deprecated
Readonly
iam_role_arn Amazon Resource Name for IAM role CSM needs to assume

This field is DEPRECATED. Please use the field credentials.		 string Deprecated
id Unique identifier of this resource string Readonly
Sortable
instance_stats Instance statistics

Stores statistics of the number of managed, unmanaged and error virtual
machines.
InstanceStats Readonly
regions_count Count of the regions accessible integer Readonly
resource_type Must be set to the value AwsAccount string
secret_key Secret key of cloud account

This field is DEPRECATED. Please use the field credentials.		 string Deprecated
status Status of the account AwsAccountStatus Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tenant_id Tenant ID

Tenant ID of the cloud account.		 string Readonly
vpc_stats VPC statistics VpcStats Readonly

AwsAccountStatus (schema)

AWS account status

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
credentials_status Credentials Status

Status of the cloud account credentials synced at the auto interval.
string Readonly
Enum: VALID, INVALID
error_message Error encountered while syncing AWS inventory

Error encountered while syncing AWS inventory such as read timeout.		 string Readonly
inventory_sync_status Inventory Synchronization Status

Status of inventory synchronization process.		 string Readonly
Enum: SYNCED, IN_PROGRESS
inventory_sync_step Inventory sync step

Step of the inventory synchronization process		 string Readonly
Enum: SYNCING_AWS_REGIONS, SYNCING_AWS_VPCS, SYNCING_AWS_AZS, SYNCING_VMS, SYNCING_NSX_DATA, SYNCING_AWS_GATEWAYS, SYNCING_MANAGED_INSTANCES, NOT_APPLICABLE

AwsAccountsListRequestParameters (schema)

These parameters will be used to filter the list of accounts.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Identifier for region based on which accounts statistics will be aggregated. Using this request parameter will return only all_accounts_vpc_stats and all_accounts_instance_stats properties. string
sort_ascending boolean
sort_by Field by which records are sorted string

AwsAccountsListResult (schema)

Cloud accounts list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
all_accounts_instance_stats Instance statistics

This field is DEPRECATED. To obtain statistics about instances, use the
GET /csm/accounts/statistics API.
InstanceStats Deprecated
Readonly
all_accounts_vpc_stats VPC statistics

This field is DEPRECATED. To obtain statistics about VPCs, use the
GET /csm/accounts/statistics API.
VpcStats Deprecated
Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results AWS accounts list result array of AwsAccount Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsAvailabilityZoneInfo (schema)

Availability Zone information

Name Description Type Notes
display_name Display name of the availability zone string Readonly
id ID of the availability zone string Readonly

AwsCredentials (schema)

AWS Account Credentials

Stores information about AWS account credentials.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
access_key Access Key

Access key of the AWS account.		 string
gateway_role Gateway Role Name

Name of the IAM service role that should be attached to the Cloud
Gateways deployed in the AWS account. Based on the permissions in the
role, the gateways will have access to resources in the AWS account.
string
secret_key Secret Key

Secret key of the AWS account.		 string

AwsGatewayAmiInfo (schema)

Aws Gateway Ami Information

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
ami_id AMI id

The ID of the Amazon Machine Image		 string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
region_id Name of the Aws Region in which ami is present string Required
resource_type Must be set to the value AwsGatewayAmiInfo string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

AwsGatewayAmisListRequestParameters (schema)

These paramaters will be used to filter the list of AWS Gateway AMIs.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Identifier for region based on which list of AWS Gateway AMIs will be obtained string
sort_ascending boolean
sort_by Field by which records are sorted string

AwsGatewayAmisListResult (schema)

List of Aws Gateway amis

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Aws Gateway amis list array of AwsGatewayAmiInfo
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsGatewayConfig (schema)

AWS gateway configuration

Stores AWS gateway configuration like ami_id, key_pair_name and
gateway_ha_configuration.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
ami_id AMI id

The ID of the Amazon Machine Image on which this gateway resides
string
cloud_fallback_security_group_id Id of cloud security group

Id of security group where the VMs should be moved after last gateway
undeployed.
string
default_quarantine_policy_enabled Flag to identify if default quarantine policy is enabled boolean
dns_settings DNS settings

Settings related to Cloud gateway DNS configuration. This determines
DNS configuration based on dns_mode.
DnsSettings
gateway_ha_configuration Aws Gateway HA configuration array of AwsGatewayHaConfig
is_ha_enabled Flag to identify if HA is enabled boolean
key_pair_name The key pair name required to authenticate into any instance string
nsx_manager_connection NSX Manager connection

Determines if connection to NSX Manager is via public IP or private IP
string Enum: PUBLIC_IP, PRIVATE_IP
proxy_server_profile Id of the proxy server profile

Id of the proxy server profile, corresponding proxy settings
will be applied while deploying the gateway.
string
vpn_service_enabled Flag to enable or disable inter-operation with services via VPN

Flag that will enable or disable inter-operation between NSX and
non-NSX services via VPN.
boolean Default: "True"

AwsGatewayDeployConfig (schema)

Aws gateway deployment configuration

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
account_id ID of the Aws account string Required
configuration Configuration of this gateway AwsGatewayConfig Readonly
vpc_id ID of the vpc string Required

AwsGatewayHaConfig (schema)

AWS subnet configuration to deploy gateways

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
availability_zone Availability Zone string Required
downlink_subnet Downlink subnet string Required
gateway_ha_index Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway. integer Required
management_subnet Management subnet string Required
public_ip_settings Public IP settings for management interface

Stores settings related to AWS gateway Public IP configuration.
The public_ip will be attached to management interface of the
gateway, based on the value of ip_allocation_mode.
GatewayPublicIp
uplink_public_ip_settings Public IP settings for uplink interface

Stores settings related to AWS gateway Public IP configuration.
The public_ip will be attached to uplink interface of
the primary gateway, based on the value of ip_allocation_mode.
GatewayPublicIp
uplink_subnet Uplink subnet string Required

AwsGatewayInfo (schema)

AWS Gateway Information

Stores AWS gateway information like configuration and status.

Name Description Type Notes
configuration Gateway Configuration

Configuration of AWS gateway		 AwsGatewayConfig Readonly
csm_ip_address Cloud service manager IP address

Cloud service manager IP address used to communicate
with the AWS Vpc gateways.
string Readonly
gateway_status Gateway Status

Array of gateway statuses		 AwsGatewayStatus Readonly

AwsGatewayInstanceStatus (schema)

AWS gateway instance status

Stores information about AWS gateway instance status

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
deployment_step Different states of gateway deployment string Readonly
Enum: VALIDATING_ENVIRONMENT, COPYING_IMAGE, CREATING_SECURITY_GROUPS, LAUNCHING_GATEWAY, CREATING_NETWORK_INTERFACES, ATTACHING_NETWORK_INTERFACES, ATTACHING_SECURITY_GROUPS, CONFIGURING_GATEWAY, CREATING_LOGICAL_NETWORK_CONSTRUCTS, DEPLOYMENT_SUCCESSFUL, DEPLOYMENT_FAILED, UNCONFIGURING_GATEWAY, RELEASING_EIPS, TERMINATING_GATEWAY, DELETING_SECURITY_GROUPS, DELETING_CLOUD_RESOURCES, UNDEPLOYMENT_SUCCESSFUL, UNDEPLOYMENT_FAILED, NOT_APPLICABLE
error_code Error code for gateway deployment/undeployment failure integer Readonly
error_message Error message for gateway deployment/undeployment failure string Readonly
gateway_ha_index Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway. integer
gateway_instance_id ID of the gateway instance string
gateway_lcp_connectivity_status Gateway to NSX Controller connectivity status

Status of connectivity between NSX controller and public cloud gateway.
string Readonly
Enum: UP, DOWN, DEGRADED, UNKNOWN
gateway_mpa_connectivity_status Gateway to NSX Manager connectivity status

Status of connectivity between NSX manager and public cloud gateway.
string Readonly
Enum: UP, DOWN, UNKNOWN
gateway_name Name of the gateway instance string
gateway_node_id NSX Node ID of the public cloud gateway string
gateway_status Gateway instance status string Readonly
Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING
gateway_tn_id NSX transport node id of the public cloud gateway string
is_gateway_active Flag to identify if this is an active gateway boolean Readonly
private_ip Private IP address of the virtual machine string Readonly
public_ip Public IP address of the virtual machine string Readonly
vpn_private_ip VPN Private IP address

Private IP address of the virtual machine for VPN		 string Readonly

AwsGatewayStatus (schema)

AWS Gateway Status

Stores AWS gateway status related information

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
gateway_cluster_id NSX gateway cluster ID

Cluster ID of NSX gateway		 string
gateway_instances_status Gateway Instances Status

Array of gateway instances statuses		 array of AwsGatewayInstanceStatus Readonly

AwsGatewayUndeployConfig (schema)

Aws gateway undeployment configuration

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
account_id ID of the Aws account string Required
instance_id ID of the gateway instance string Required

AwsGatewaysListRequestParameters (schema)

These paramaters will be used to filter the list of Aws Gateways.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Optional identifier for account based on which AWS gateways list can be
filtered.
string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Optional identifier for region based on which AWS gateways list can be
filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string
vpc_id VPC ID

Optional identifier for vpc based on which AWS gateways list can be
filtered.
string

AwsGatewaysListResult (schema)

AWS Gateways List Result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Vpc list array of AwsGatewayDeployConfig
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsKeyPair (schema)

Aws Key Pair

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
name Name of the Aws Key Pair string Required

AwsKeyPairList (schema)

List of Aws Key Pairs

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Aws Key Pairs list array of AwsKeyPair
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsKeyPairListRequestParameters (schema)

These paramaters will be used to filter the list of subnets.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Identifier for account based on which list of key pairs will be obtained string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Identifier for region based on which list of key pairs will be obtained string Required
sort_ascending boolean
sort_by Field by which records are sorted string

AwsPublicIpListResult (schema)

Aws Public IP List Result

Stores a list of Aws public IPs.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results AWS public IP

Array of Aws public IPs.
array of string Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsRegion (schema)

Aws Region Information

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
associated_account_ids Associated AWS Account IDs

Array of associated AWS account IDs.		 array of string
availability_zones Availability zones under this region array of AwsAvailabilityZoneInfo Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
gateway_stats Gateway statistics GatewayStats Readonly
has_managed_vpc Has a managed VPC? boolean Readonly
id Unique identifier of this resource string Readonly
Sortable
instance_stats Instance statistics InstanceStats Readonly
resource_type Must be set to the value AwsRegion string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vpc_stats VPC statistics VpcStats Readonly

AwsRegionsListRequestParameters (schema)

These paramaters will be used to filter the list of regions.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Identifier for account based on which regions are to be filtered string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Identifier for region based on which the list can be filtered or can be used to validate that hierarchy is correct string
sort_ascending boolean
sort_by Field by which records are sorted string

AwsRegionsListResult (schema)

AwsRegions list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Aws Regions list result array of AwsRegion
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsResourcesListRequestParameters (schema)

Aws Resource List Request Parameters

A set of filter parameters to list Aws resources. Multiple parameters
can be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Mandatory identifier for account based on which resources are
to be filtered.
string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Optional identifier for region based on which resources
are to be filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string

AwsSecurityGroup (schema)

Aws Security Group

Stores Aws security group information.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
security_group_id Security Group ID

ID of the cloud security group.
string
security_group_name Security Group Name

Name of the cloud security group.
string

AwsSecurityGroupsListRequestParameters (schema)

Aws Security Groups List Request Parameters

A set of filter parameters to list Aws security groups. Multiple parameters
can be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Mandatory identifier for account based on which resources are
to be filtered.
string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Optional identifier for region based on which resources
are to be filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string
vpc_id Region ID

Optional identifier for region based on which resources
are to be filtered.
string Required

AwsSecurityGroupsListResult (schema)

Aws Security Groups List Result

Stores a list of Aws security groups.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of Aws security groups.
array of AwsSecurityGroup Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsSubnet (schema)

Aws subnet

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
availability_zone string
cidr IPV4 CIDR Block for the Vpc string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id ID of subnet string Required
resource_type Must be set to the value AwsSubnet string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vpc_id ID of the vpc string Required

AwsSubnetListRequestParameters (schema)

These paramaters will be used to filter the list of subnets.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Identifier for account based on which subnets are to be filtered string Required
availability_zone_name Identifier for availability zone based on which subnets are to be filtered string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_name Identifier for region based on which subnets are to be filtered string Required
sort_ascending boolean
sort_by Field by which records are sorted string
vpc_id Identifier for vpc based on which subnets are to be filtered string Required

AwsSubnetListResult (schema)

Aws subnets list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Aws subnets list result array of AwsSubnet Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AwsVirtualMachine (schema)

Aws Virtual Machine Information

Stores information about a AWS Virtual Machine

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
agent_status Agent Status string Readonly
Enum: UP, DOWN, NO_AGENT
agent_version Agent version details string Readonly
associated_account_ids Associated Cloud Account IDs

Array of associated cloud account IDs.		 array of string
availability_zone AWS Availability Zone

AWS availability zone in which virtual machine is residing		 string Readonly
cloud_tags Cloud tags for the virtual machine array of CloudTag Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
error_messages List of error messages

List of error messages identified. Returns only error messages
identified in the last 1 hour.
array of ComputeInstanceErrorMessage Readonly
gateway_ha_index Gateway HA Index

Index of HA that indicates whether gateway is primary or secondary.
If index is 0, then it is primary gateway. Else secondary gateway.
integer
gateway_status Gateway Status string Readonly
Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING
id Unique identifier of this resource string Readonly
Sortable
is_gateway Flag to identify if this VM is a gateway node boolean Readonly
is_gateway_active Flag to identify if this VM is an active gateway node boolean Readonly
logical_switch_display_name Logical Switch display name string Readonly
logical_switch_id Logical Switch ID string Readonly
managed_by_nsx Indicate if vm is managed by NSX or not boolean Required
Readonly
nsx_ip IP address provided by NSX string Readonly
os_details Operating system details string Readonly
os_type Operating system of the virtual machine string Readonly
power_state Power State

Indicates the power state of the virtual machine as returned by AWS.
string Readonly
Enum: PENDING, RUNNING, SHUTTING_DOWN, TERMINATED, STOPPING, STOPPED
private_ip Private IP address of the virtual machine string Readonly
public_ip Public IP address of the virtual machine string Readonly
quarantine_state Quarantine State

Indicates the quarantine state of the VM.
QUARANTINED - This state implies VM is moved to quarantine security
group because some threat has been detected.
NOT_QUARANTINED - This state implies no quarantine action has been
taken.
UNKNOWN - This state implies either quarantine policy is disabled or
quarantine information is not available.
OVERRIDDEN - This state implies VM is associated with vm_override_sg
which overrides any action based on threat detection.
string Readonly
Enum: QUARANTINED, NOT_QUARANTINED, UNKNOWN, OVERRIDDEN
region AWS Region

AWS region in which virtual machine is residing		 string Readonly
resource_type Must be set to the value AwsVirtualMachine string Required
Enum: AwsVirtualMachine, AzureVirtualMachine
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
threat_state Threat State

Indicates the threat state of the VM.
NORMAL - This state implies no threat has been detected and VM is
functioning as expected.
THREAT - This state implies quarantine enabling threat has been
detected.
INVALID - This state implies either VM is unmanaged or threat related
information is not available.
string Readonly
Enum: NORMAL, THREAT, INVALID
vm_extension_execution_status VM extension script execution status

UNKNOWN - This is the default state. Indicates no information available
regarding extension execution. This can potentially occur for
a VM when agent is installed out of band or if
cloud_agent_automated_install_enabled flag is enabled for the
VNET/VPC which already has managed VMs.
SUCCESSFUL - Indicates VM extension script execution was successful.
This does not necessarily mean agent installation was
successful.
FAILED - Indicates VM extension script execution failed.
string Readonly
vpc AWS VPC

AWS VPC ID in which virtual machine is residing		 string Readonly
vpc_name AWS VPC name

AWS VPC name in which virtual machine is residing		 string Readonly

AwsVpc (schema)

Vpc Information

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
ami_id AMI ID

Amazon Machine Image is a special type of virtual appliance that is
used to create a virtual machine with the Amazon Elastic Compute
Cloud. It serves as the basic unit of deployment for services
delivered using Amazon EC2
string Readonly
associated_account_ids Associated AWS Account IDs

Array of associated AWS account IDs.		 array of string
cidr IPV4 CIDR Block for the Vpc

This field is DEPRECATED as AWS started supporting multiple CIDR
blocks per VPC. This field will return only the first CIDR block
from the response received from AWS. Please use cidr_blocks to
see the multiple CIDR blocks associated with the VPC.
string Deprecated
Readonly
cidr_blocks IPv4 CIDR Block

IPv4 CIDR Block of the virtual network.		 array of CidrBlock Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
gateway_info Gateway details for the Vpc AwsGatewayInfo Readonly
id Unique identifier of this resource string Readonly
Sortable
instance_stats Managed, unmanaged and error instance counts for the Vpc InstanceStats Readonly
is_management_vpc Flag to identify if this is the management Vpc boolean Readonly
Default: "False"
op_status State of the Vpc string Readonly
Enum: NSX_MANAGED, NSX_UNMANAGED
region_id Id of the AWS region string Readonly
resource_type Must be set to the value AwsVpc string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_zones Transport zones for the Vpc array of TransportZoneInfo Readonly

AwsVpcListRequestParameters (schema)

These paramaters will be used to filter the list of Vpcs.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Identifier for account based on which vpcs are to be filtered string
cidr IPV4 CIDR Block for the Vpc string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
op_status Identifier for state based on which vpcs are to be filtered string Enum: NSX_MANAGED, NSX_UNMANAGED
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Identifier for region based on which vpcs are to be filtered string
sort_ascending boolean
sort_by Field by which records are sorted string
vpc_id Identifier for vpc based on which the list can be filtered or can be used to validate that hierarchy is correct string

AwsVpcListResult (schema)

Vpc list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Vpc list array of AwsVpc
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureAccount (schema)

Azure Account

Stores information about an Azure account

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
auth_method Azure account authorization method

This property conveys the authorization method to use. Appropriate
credentials/parameters will be expected based on this method selection.
string Readonly
Enum: CREDENTIALS
auth_users Authrized Users

List of authorized users.		 array of CloudUserInfo Readonly
cloud_tags_enabled Boolean flag to enable or disable cloud tags discovery

Boolean flag to enable or disable cloud tags discovery. The discovered
cloud tags can be used to define security group membership.
boolean Default: "True"
cloud_type Cloud Type string Required
Enum: AWS, AZURE, GOOGLE
credentials Azure Credentials

Credentials of Azure Account.		 AzureCredentials Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
has_managed_vnet Has a managed virtual network?

This field is DEPRECATED. Please use vnet_stats to get the number of
managed virtual networks.
boolean Deprecated
Readonly
id Unique identifier of this resource string Readonly
Sortable
instance_stats Instance statistics

Stores statistics of the number of managed, unmanaged and error virtual
machines.
InstanceStats Readonly
regions_count Azure Regions Count

Count of the regions accessible.		 integer Readonly
resource_type Must be set to the value AzureAccount string
status Azure Account Status

Status of the Azure Account.		 AzureAccountStatus Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tenant_id Tenant ID

Tenant ID of the cloud account.		 string Readonly
vnet_stats Virtual Network Statistics

Stores statistics of the number of MANAGED and UNMANAGED virtual
networks.
VnetStats Readonly

AzureAccountStatus (schema)

Azure Account Status

Stores information about Azure account status.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
credentials_status Credentials Status

Status of the cloud account credentials synced at the auto interval.
string Readonly
Enum: VALID, INVALID
error_message Error encountered while syncing azure inventory

Error encountered while syncing azure inventory such as read timeout.		 string Readonly
inventory_sync_status Inventory Synchronization Status

Status of inventory synchronization process.		 string Readonly
Enum: SYNCED, IN_PROGRESS
inventory_sync_step Inventory sync step

Step of the inventory synchronization process.		 string Readonly
Enum: SYNCING_AZURE_REGIONS, SYNCING_AZURE_VNETS, SYNCING_VMS, SYNCING_NSX_DATA, SYNCING_AZURE_GATEWAYS, SYNCING_MANAGED_INSTANCES, NOT_APPLICABLE

AzureAccountsListResult (schema)

Azure Accounts List Result

Stores a list of Azure accounts.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of Azure accounts.		 array of AzureAccount Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureCredentials (schema)

Azure Account Credentials

Stores information about Azure account credentials

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
client_id Azure Account Client ID

Client ID of the Azure account.		 string
gateway_role Azure role name for gateway

Default Azure Managed Service Identity role that will be set to the
Cloud Gateways deployed in the Azure account. Based on the permissions
in the role, the gateways will have access to resources in the Azure
account.
string
key Azure Account Key

Key of the Azure account. Used only to take input. Will never be
returned in any API response.
string
subscription_id Azure Account Subscription ID

Subscription ID of the Azure account.		 string
tenant_id Azure Account Tenant ID

Tenant ID of the Azure account.		 string

AzureGatewayConfig (schema)

Azure gateway configuration

Stores Azure gateway configuration like image_id, ssh_key and
gateway_ha_configuration.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
auto_agent_install_enabled Auto Agent Install Enabled

Flag to identify if NSX agent installation will be done automatically or not.
As of now this is supported for Azure Cloud only.
boolean Default: "False"
cloud_fallback_security_group_id Id of cloud security group

Id of security group where the VMs should be moved after last gateway
undeployed.
string
default_quarantine_policy_enabled Flag to identify if default quarantine policy is enabled boolean
dns_settings DNS settings

Settings related to Cloud gateway DNS configuration. This determines
DNS configuration based on dns_mode.
DnsSettings
gateway_ha_configuration Azure Gateway HA configuration array of AzureGatewayHaConfig
image_id NSX PCG Image ID

The ID of the Public Cloud Gateway image in Azure
string
is_ha_enabled Flag to identify if HA is enabled boolean
nsx_manager_connection NSX Manager connection

Determines if connection to NSX Manager is via public IP or private IP
string Enum: PUBLIC_IP, PRIVATE_IP
proxy_server_profile Id of the proxy server profile

Id of the proxy server profile, corresponding proxy settings
will be applied while deploying the gateway.
string
ssh_key SSH Key

This key will be associated to Public Cloud Gateway instance while
it is launched in Azure.
string
storage_account_name Azure Storage Account Name

Azure Storage Account where gateway image will be copied.
string
vpn_service_enabled Flag to enable or disable inter-operation with services via VPN

Flag that will enable or disable inter-operation between NSX and
non-NSX services via VPN.
boolean Default: "True"

AzureGatewayDeployConfig (schema)

Azure gateway deployment configuration

Stores configuration for Azure gateway deployment request.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
account_id Azure Account ID

ID of the Azure account.		 string Required
configuration Azure Gateway Configuration

Configuration of Azure gateway.		 AzureGatewayConfig Required
vnet_id Azure Virtual Network ID

ID of the Azure Virtual Network. It consists of resourceGuid of Azure Vnet.		 string Required

AzureGatewayHaConfig (schema)

Azure subnet configuration to deploy gateways

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
downlink_subnet Downlink subnet string Required
gateway_ha_index Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway. integer Required
management_subnet Management subnet string Required
public_ip_settings Public IP settings

Stores settings related to Azure gateway Public IP configuration.
The public_ip will be attached for management interface of the gateway.
GatewayPublicIp
uplink_public_ip_settings Public IP settings for uplink interface

Stores settings related to Azure gateway Public IP configuration.
The public_ip will be attached to uplink interface of
the primary gateway, based on the value of ip_allocation_mode.
GatewayPublicIp
uplink_subnet Uplink subnet string Required

AzureGatewayInfo (schema)

Azure Gateway Information

Stores azure gateway information like configuration and status.

Name Description Type Notes
configuration Gateway Configuration

Configuration of Azure gateway.		 AzureGatewayConfig Readonly
csm_ip_address Cloud service manager IP address

Cloud service manager IP address used to communicate
with the Azure Vnet gateways.
string Readonly
gateway_status Gateway Status

Array of gateway statuses.		 AzureGatewayStatus Readonly

AzureGatewayInstanceStatus (schema)

Azure gateway instance status

Stores information about Azure gateway instance status

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
azure_image_bytes_copied Bytes copied, while copying image

Displays number of bytes copied, while copying gateway image.		 integer Readonly
azure_image_copy_progress Progress Percentage for image copy

Displays progress percentage while copying gateway image.		 integer Readonly
azure_image_total_bytes Total bytes required to be copied, for copying image

Displays total number of bytes required to be copied, for copying gateway image.		 integer Readonly
deployment_step Different states of gateway deployment string Readonly
Enum: VALIDATING_ENVIRONMENT, COPYING_IMAGE, CREATING_SECURITY_GROUPS, LAUNCHING_GATEWAY, CREATING_NETWORK_INTERFACES, ATTACHING_NETWORK_INTERFACES, ATTACHING_SECURITY_GROUPS, CONFIGURING_GATEWAY, CREATING_LOGICAL_NETWORK_CONSTRUCTS, DEPLOYMENT_SUCCESSFUL, DEPLOYMENT_FAILED, UNCONFIGURING_GATEWAY, RELEASING_EIPS, TERMINATING_GATEWAY, DELETING_SECURITY_GROUPS, DELETING_CLOUD_RESOURCES, UNDEPLOYMENT_SUCCESSFUL, UNDEPLOYMENT_FAILED, NOT_APPLICABLE
error_code Error code for gateway deployment/undeployment failure integer Readonly
error_message Error message for gateway deployment/undeployment failure string Readonly
gateway_ha_index Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway. integer
gateway_instance_id ID of the gateway instance string
gateway_lcp_connectivity_status Gateway to NSX Controller connectivity status

Status of connectivity between NSX controller and public cloud gateway.
string Readonly
Enum: UP, DOWN, DEGRADED, UNKNOWN
gateway_mpa_connectivity_status Gateway to NSX Manager connectivity status

Status of connectivity between NSX manager and public cloud gateway.
string Readonly
Enum: UP, DOWN, UNKNOWN
gateway_name Name of the gateway instance string
gateway_node_id NSX Node ID of the public cloud gateway string
gateway_status Gateway instance status string Readonly
Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING
gateway_tn_id NSX transport node id of the public cloud gateway string
is_gateway_active Flag to identify if this is an active gateway boolean Readonly
private_ip Private IP address of the virtual machine string Readonly
public_ip Public IP address of the virtual machine string Readonly
vpn_private_ip VPN Private IP address

Private IP address of the virtual machine for VPN		 string Readonly

AzureGatewayStatus (schema)

Azure Gateway Status

Stores Azure gateway status related information

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
gateway_cluster_id NSX gateway cluster ID

Cluster ID of NSX gateway		 string
gateway_instances_status Gateway Instances Status

Array of gateway instances statuses		 array of AzureGatewayInstanceStatus Readonly

AzureGatewayUndeployConfig (schema)

Azure gateway undeployment configuration

Stores configuration for Azure gateway undeployment request.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
account_id Azure Account ID

ID of the Azure account.		 string Required
instance_id Azure Instance ID

ID of the gateway instance.		 string Required

AzureGatewaysListRequestParameters (schema)

Azure Gateways List Request Parameters

A set of optional filter parameters to list Azure gateways. Multiple
parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Azure Account ID

Optional identifier for account based on which Azure gateways list can
be filtered.
string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Azure Region ID

Optional identifier for region based on which Azure Gateways list can
be filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string
vnet_id Azure Virtual Network ID

Optional identifier for virtual network based on which Azure Gateways
list can be filtered. It consists of resourceGuid of Azure Vnet.
string

AzureGatewaysListResult (schema)

Azure Gateways List Result

Stores a list of Azure gateways.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of Azure gateways.		 array of AzureGatewayDeployConfig
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzurePublicIpListRequestParameters (schema)

Azure Public IP List Request Parameters

A set of filter parameters to list Azure Public IPs. Multiple parameters
can be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Mandatory identifier for account based on which public IPs are
to be filtered.
string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Optional identifier for region based on which public IPs
are to be filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string

AzurePublicIpListResult (schema)

Azure Public IP List Result

Stores a list of Azure public IPs.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Azure Public IP

Array of Azure Public IPs.
array of string Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureRegion (schema)

Azure Region Information

Stores information about an Azure region.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
associated_account_ids Associated Azure Account IDs

Array of associated Azure account IDs.		 array of string
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
gateway_stats Gateway Statistics

Stores statistics of the number of UP, DOWN and DEPLOYING gateways.
GatewayStats Readonly
has_managed_vnet Has a managed Virtual Network? boolean Readonly
id Unique identifier of this resource string Readonly
Sortable
instance_stats Instance Statistics

Stores statistics of the number of MANAGED, UNMANAGED and ERROR instances.
InstanceStats Readonly
resource_type Must be set to the value AzureRegion string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vnet_stats Virtual Network Statistics

Stores statistics of the number of MANAGED and UNMANAGED virtual networks.
VnetStats Readonly

AzureRegionsListRequestParameters (schema)

Azure Regions List Request Parameters

A set of optional filter parameters to list Azure regions. Multiple
parameters can be given as input to use 'AND' them.

Name Description Type Notes
account_id Azure Account ID

Optional identifier for account based on which regions list can be
filtered.
string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Azure Region ID

Optional identifier for region based on which the regions list can be
filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string

AzureRegionsListResult (schema)

Azure Regions List Result

A list of Azure regions.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of Azure regions.		 array of AzureRegion
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureResourceGroup (schema)

Azure Resource Group

Stores Azure resource group information.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
resource_group_id Id of resource group

Id of resource group.
string
resource_group_name Name of resource group

Name of resource group.
string

AzureResourceGroupsListResult (schema)

Azure Resource Groups List Result

Stores a list of Azure resource groups.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Azure resource groups Results

Array of Azure resource groups.
array of AzureResourceGroup Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureResourcesListRequestParameters (schema)

Azure Resource List Request Parameters

A set of filter parameters to list Azure resources. Multiple parameters
can be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Mandatory identifier for account based on which resources are
to be filtered.
string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Optional identifier for region based on which resources
are to be filtered.
string
resource_group_id Resource Group ID

Optional identifier for resource group id based on which resources
are to be filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string

AzureSecurityGroup (schema)

Azure Security Group

Stores Azure security group information.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
security_group_id Security Group ID

ID of the cloud security group.
string
security_group_name Security Group Name

Name of the cloud security group.
string

AzureSecurityGroupsListResult (schema)

Azure Secuirty Groups List Result

Stores a list of Azure secuity groups.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Azure security groups Results

Array of Azure security groups.
array of AzureSecurityGroup Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureStorageAccount (schema)

Azure Storage Account

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
name Name of the Azure Storage Account string Required

AzureStorageAccountList (schema)

List of Azure Storage Accounts

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Azure Storage Accounts list array of AzureStorageAccount
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureStorageAccountsListRequestParameters (schema)

These paramaters will be used to filter the list of storage accounts.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Identifier for account based on which list of storage accounts will be obtained string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Identifier for region based on which list of storage accounts will be obtained string Required
sort_ascending boolean
sort_by Field by which records are sorted string

AzureSubnet (schema)

Azure Subnet

Stores information about an Azure subnet.

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
address_space Azure subnet address space string Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id ID of Subnet string Readonly
resource_type Must be set to the value AzureSubnet string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vnet_id Azure Virtual Network ID

ID of the Azure Virtual Network.It consists of resourceGuid of Azure Vnet.		 string Readonly

AzureSubnetListRequestParameters (schema)

Azure Subnet List Request Parameters

A set of filter parameters to list Azure subnets. Multiple parameters can
be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Mandatory identifier for account based on which subnets are to be filtered.
string Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Identifier for region based on which subnets are to be filtered.
string Required
sort_ascending boolean
sort_by Field by which records are sorted string
vnet_id Virtual Network ID

Identifier for vnet based on which subnets are to be filtered. It consists of resourceGuid of Azure Vnet.
string Required

AzureSubnetListResult (schema)

Azure subnets List Result

Stores a list of Azure subnets.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of Azure subnets.
array of AzureSubnet Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

AzureVirtualMachine (schema)

Azure Virtual Machine Information

Stores information about a Azure Virtual Machine

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
agent_status Agent Status string Readonly
Enum: UP, DOWN, NO_AGENT
agent_version Agent version details string Readonly
associated_account_ids Associated Cloud Account IDs

Array of associated cloud account IDs.		 array of string
cloud_tags Cloud tags for the virtual machine array of CloudTag Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
error_messages List of error messages

List of error messages identified. Returns only error messages
identified in the last 1 hour.
array of ComputeInstanceErrorMessage Readonly
gateway_ha_index Gateway HA Index

Index of HA that indicates whether gateway is primary or secondary.
If index is 0, then it is primary gateway. Else secondary gateway.
integer
gateway_status Gateway Status string Readonly
Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING
id Unique identifier of this resource string Readonly
Sortable
is_gateway Flag to identify if this VM is a gateway node boolean Readonly
is_gateway_active Flag to identify if this VM is an active gateway node boolean Readonly
logical_switch_display_name Logical Switch display name string Readonly
logical_switch_id Logical Switch ID string Readonly
managed_by_nsx Indicate if vm is managed by NSX or not boolean Required
Readonly
nsx_ip IP address provided by NSX string Readonly
os_details Operating system details string Readonly
os_type Operating system of the virtual machine string Readonly
power_state Power State

Indicates power state of the virtual machine as returned by Azure.
string Readonly
Enum: RUNNING, DEALLOCATING, DEALLOCATED, STARTING, STOPPED, STOPPING, UNKNOWN
private_ip Private IP address of the virtual machine string Readonly
public_ip Public IP address of the virtual machine string Readonly
quarantine_state Quarantine State

Indicates the quarantine state of the VM.
QUARANTINED - This state implies VM is moved to quarantine security
group because some threat has been detected.
NOT_QUARANTINED - This state implies no quarantine action has been
taken.
UNKNOWN - This state implies either quarantine policy is disabled or
quarantine information is not available.
OVERRIDDEN - This state implies VM is associated with vm_override_sg
which overrides any action based on threat detection.
string Readonly
Enum: QUARANTINED, NOT_QUARANTINED, UNKNOWN, OVERRIDDEN
region Azure region

Azure region in which virtual machine is residing		 string Readonly
resource_group Resource Group

Resource Group of the Azure Virtual Machine.		 string Readonly
resource_id Azure Virtual Machine resource id

Resource Id of Azure Virtual Machine.		 string Readonly
resource_type Must be set to the value AzureVirtualMachine string Required
Enum: AwsVirtualMachine, AzureVirtualMachine
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
threat_state Threat State

Indicates the threat state of the VM.
NORMAL - This state implies no threat has been detected and VM is
functioning as expected.
THREAT - This state implies quarantine enabling threat has been
detected.
INVALID - This state implies either VM is unmanaged or threat related
information is not available.
string Readonly
Enum: NORMAL, THREAT, INVALID
vm_extension_execution_status VM extension script execution status

UNKNOWN - This is the default state. Indicates no information available
regarding extension execution. This can potentially occur for
a VM when agent is installed out of band or if
cloud_agent_automated_install_enabled flag is enabled for the
VNET/VPC which already has managed VMs.
SUCCESSFUL - Indicates VM extension script execution was successful.
This does not necessarily mean agent installation was
successful.
FAILED - Indicates VM extension script execution failed.
string Readonly
vnet Azure virtual network

Azure virtual network ID in which virtual machine is residing
string Readonly
vnet_name Azure virtual network name

Azure virtual network name in which virtual machine is residing
string Readonly

AzureVnet (schema)

Azure VNet

Stores information about an Azure VNet (Virtual Network).

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
agent_info Azure Agent Information

Array of agent install and download instructions for various OS types.		 array of AgentInfo Readonly
associated_account_ids Associated Azure Account IDs

Array of associated Azure account IDs.		 array of string
cidr_blocks IPv4 CIDR Block

IPv4 CIDR Block of the virtual network.		 array of CidrBlock Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
gateway_info Gateway Info

Gateway information of the virtual network like configuration and status.
AzureGatewayInfo Readonly
id Unique identifier of this resource string Readonly
Sortable
instance_stats Instance Statistics

Stores statistics of the number of MANAGED, MANAGED and ERROR instances.
InstanceStats Readonly
is_management_vnet Is Management VNet?

This flag indicates if this is a management virtual network.		 boolean Readonly
Default: "False"
op_status Operational Status

Operational status of the virtual network.		 string Readonly
Enum: NSX_MANAGED, NSX_UNMANAGED
region_id Region ID

ID of the Azure region.		 string Readonly
resource_group Resource Group

Resource Group of the Azure Vnet.		 string Readonly
resource_id Azure Vnet resource id

Resource Id of Azure Vnet.		 string Readonly
resource_type Must be set to the value AzureVnet string
storage_account_name Azure Storage Account Name

Azure Storage Account where gateway image will be copied.		 string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_zones Transport Zones

Array of transport zones in the virtual network.		 array of TransportZoneInfo Readonly

AzureVnetListRequestParameters (schema)

Azure VNet List Request Parameters

A set of optional filter parameters to list Azure virtual networks.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Optional identifier for account based on which virtual networks list
can be filtered.
string
cidr IPv4 CIDR Block

Optional identifier for IPv4 CIDR Block based on which virtual networks
list can be filtered.
CidrBlock
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
op_status Operational Status

Optional identifier for operational status based on which virtual
networks list can be filtered.
string Enum: NSX_MANAGED, NSX_UNMANAGED
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Optional identifier for region based on which virtual networks list can
be filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string
vnet_id Virtual Network ID

Optional identifier for virtual network based on which virtual networks
list can be filtered. It consists of resourceGuid of Azure Vnet.
string

AzureVnetListResult (schema)

Azure VNet List Result

Stores a list of Azure virtual networks.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of Azure virtual networks.		 array of AzureVnet
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

BFDDiagnosticCount (schema)

Name Description Type Notes
administratively_down_count Number of tunnels with administratively down diagnostic message integer
concatenated_path_down_count Number of tunnels with concatenated path down diagnostic message integer
control_detection_time_expired_count Number of tunnels with control detection time expired diagnostic message integer
echo_function_failed_count Number of tunnels with echo function failed diagnostic message integer
forwarding_plane_reset_count Number of tunnels with forwarding plane reset diagnostic message integer
neighbor_signaled_session_down_count Number of tunnels neighbor signaled session down integer
no_diagnostic_count Number of tunnels with no diagnostic integer
path_down_count Number of tunnels with path down diagnostic message integer
reverse_concatenated_path_down_count Number of tunnels with reverse concatenated path down diagnostic message integer

BFDProperties (schema)

BFD information

Name Description Type Notes
active True if tunnel is active in a gateway HA setup boolean Readonly
diagnostic Diagnostic message of a problem

A short message indicating what the BFD session thinks is wrong in case of a problem		 string Readonly
forwarding True if the BFD session believes this interface may be used to forward traffic boolean Readonly
remote_diagnostic Diagnostic message of a problem

A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem		 string Readonly
remote_state State of the remote interface's BFD session string Readonly
Enum: UNKNOWN_STATE, ADMIN_DOWN, DOWN, INIT, UP
state State of the BFD session string Readonly
Enum: UNKNOWN_STATE, ADMIN_DOWN, DOWN, INIT, UP

BFDStatusCount (schema)

Name Description Type Notes
bfd_admin_down_count Number of tunnels in BFD admin down state int
bfd_down_count Number of tunnels in BFD down state int
bfd_init_count Number of tunnels in BFD init state int
bfd_up_count Number of tunnels in BFD up state int

BGPCommunityList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
communities BGP community list

Array of BGP communities		 array of string Required
community_type BGP community type

Specifies the BGP community type. Currently, only NormalBGPCommunity is
supported.
string Enum: NormalBGPCommunity
Default: "NormalBGPCommunity"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value BGPCommunityList string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BGPCommunityListListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of bgp communities

Paginated list of bgp community lists		 array of BGPCommunityList
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

BackupConfiguration (schema)

Configuration for taking manual/automated backup

Name Description Type Notes
backup_enabled true if automated backup is enabled boolean Default: "False"
backup_schedule Set when backups should be taken - on a weekly schedule or at regular intervals. BackupSchedule
(Abstract type: pass one of the following concrete types)
IntervalBackupSchedule
WeeklyBackupSchedule
inventory_summary_interval The minimum number of seconds between each upload of the inventory summary to backup server. integer Minimum: 30
Maximum: 3600
Default: "300"
passphrase Passphrase used to encrypt backup files. string
remote_file_server The server to which backups will be sent. RemoteFileServer Required

BackupOperationHistory (schema)

Past backup operation details

Name Description Type Notes
cluster_backup_statuses Statuses of previous cluser backups array of BackupOperationStatus
inventory_backup_statuses Statuses of previous inventory backups array of BackupOperationStatus
node_backup_statuses Statuses of previous node backups array of BackupOperationStatus

BackupOperationStatus (schema)

Backup operation status

Name Description Type Notes
backup_id Unique identifier of a backup string Required
end_time Time when operation was ended EpochMsTimestamp
error_code Error code string Enum: BACKUP_NOT_RUN_ON_MASTER, BACKUP_SERVER_UNREACHABLE, BACKUP_AUTHENTICATION_FAILURE, BACKUP_PERMISSION_ERROR, BACKUP_TIMEOUT, BACKUP_BAD_FINGERPRINT, BACKUP_GENERIC_ERROR
error_message Error code details string
start_time Time when operation was started EpochMsTimestamp
success True if backup is successfully completed, else false boolean Required

BackupSchedule (schema)

Abstract base type for Weekly or Interval Backup Schedule

This is an abstract type. Concrete child types:
IntervalBackupSchedule
WeeklyBackupSchedule

Name Description Type Notes
resource_type Schedule type string Required
Enum: WeeklyBackupSchedule, IntervalBackupSchedule

BaseHostSwitchProfile (schema)

This is an abstract type. Concrete child types:
ExtraConfigHostSwitchProfile
LldpHostSwitchProfile
NiocProfile
UplinkHostSwitchProfile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value BaseHostSwitchProfile HostSwitchProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BaseNodeAggregateInfo (schema)

Name Description Type Notes
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
id Unique identifier of this resource string Readonly
node_interface_properties Array of Node interface statistic properties array of NodeInterfaceProperties Readonly
node_interface_statistics Array of Node network interface statistic properties array of NodeInterfaceStatisticsProperties Readonly
node_status ClusterNodeStatus Readonly
node_status_properties Time series of the node's system properties array of NodeStatusProperties

BaseServiceInstance (schema)

Base Instance of a service

The deployment of a registered service. service instance is instantiation of service. This is an abstract type. Concrete child types:
ByodServiceInstance
ServiceInstance
VirtualServiceInstance

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
on_failure_policy On Failure Policy

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.		 string Enum: ALLOW, BLOCK
resource_type Must be set to the value BaseServiceInstance ServiceInstanceResourceType Required
service_id Service Id

The Service to which the service instance is associated.		 string Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_type Transport Type

Transport to be used by this service instance for deploying the Service-VM.		 string Required
Enum: L2_BRIDGE, L3_ROUTED

BaseSwitchingProfile (schema)

This is an abstract type. Concrete child types:
IpDiscoverySwitchingProfile
MacManagementSwitchingProfile
PortMirroringSwitchingProfile
QosSwitchingProfile
SpoofGuardSwitchingProfile
SwitchSecuritySwitchingProfile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value BaseSwitchingProfile string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BasicAuthenticationScheme (schema)

Name Description Type Notes
password Password to authenticate with string Required
scheme_name Authentication scheme name string Required
Enum: basic
username User name to authenticate with string Required
Pattern: "^.+$"

BatchParameter (schema)

Options that affect how batch operations are processed

Name Description Type Notes
atomic transactional atomicity for the batch of requests embedded in the batch list

use this flag if you want transactional atomicity		 boolean Default: "False"

BatchRequest (schema)

A set of operations to be performed in a single batch

Name Description Type Notes
continue_on_error Flag to decide if we will continue processing subsequent requests in case of current error for atomic = false. boolean Default: "True"
requests array of BatchRequestItem

BatchRequestItem (schema)

A single request within a batch of operations

Name Description Type Notes
body object
method method type(POST/PUT/DELETE/UPDATE)

http method type		 string Required
Enum: GET, POST, PUT, DELETE, PATCH
uri Internal uri of the call

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		 string Required

BatchResponse (schema)

The reponse to a batch operation

Name Description Type Notes
has_errors errors indicator

Indicates if any of the APIs failed		 boolean
results Bulk list results array of BatchResponseItem Required
rolled_back indicates if all items were rolled back.

Optional flag indicating that all items were rolled back even if succeeded initially		 boolean

BatchResponseItem (schema)

A single respose in a list of batched responses

Name Description Type Notes
body object returned by api

object returned by api		 object
code object returned by api

http status code		 integer Required
headers object returned by api

The headers returned by the API call		 object

BfdConfig (schema)

BFD configuration for LogicalRouter

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
declare_dead_multiple Number of times a packet is missed before BFD declares the neighbor down. integer Minimum: 2
Maximum: 16
Default: "3"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Flag to enable BFD for this LogicalRouter boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
receive_interval Receive interval for heartbeats

the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.		 integer Minimum: 100
Maximum: 60000
Default: "1000"
resource_type Must be set to the value BfdConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transmit_interval Transmit interval for heartbeats

the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.		 integer Minimum: 100
Maximum: 60000
Default: "1000"

BfdConfigParameters (schema)

BFD configuration for the given Peer.

Name Description Type Notes
declare_dead_multiple Number of times a packet is missed before BFD declares the neighbor down. integer Minimum: 2
Maximum: 16
Default: "3"
receive_interval the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats. integer Minimum: 300
Maximum: 60000
Default: "1000"
transmit_interval the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats. integer Minimum: 300
Maximum: 60000
Default: "1000"

BfdHealthMonitoringProfile (schema)

Profile for BFD health monitoring

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled 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. boolean Required
id Unique identifier of this resource string Readonly
Sortable
probe_interval The time interval (in millisec) between probe packets for tunnels between transport nodes. integer Minimum: 300
Default: "1000"
resource_type Must be set to the value BfdHealthMonitoringProfile string Required
Enum: BfdHealthMonitoringProfile
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BgpConfig (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
as_num 4 Byte ASN in ASPLAIN/ASDOT Format string
as_number Autonomous System Number

This is a deprecated property, Please use 'as_num' instead.		 integer Deprecated
Minimum: 1
Maximum: 4294967296
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
ecmp Flag to enable ECMP boolean Default: "True"
enabled Flag to enable this configuration boolean Default: "False"
graceful_restart Flag to enable graceful restart boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value BgpConfig string
route_aggregation List of routes to be aggregated array of BgpRouteAggregation Minimum items: 0
Maximum items: 1000
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BgpNeighbor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
address_families AddressFamily settings for the neighbor

User can enable the neighbor for the specific address families and also define filters per address family.
When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons.
User can change that if required, by defining the address family configuration.
array of BgpNeighborAddressFamily
bfd_config BFD Configuration Parameters for the given peer.

By specifying these paramaters BFD config for this given peer can be overriden | (the globally configured values will not apply for this peer)		 BfdConfigParameters
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enable_bfd Enable BFD for this BGP Neighbor

Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.		 boolean Default: "False"
enabled Flag to enable this BGP Neighbor boolean Default: "True"
filter_in_ipprefixlist_id IPPrefix List to be used for IN direction filter for IPV4_UNICAST address family

This is a deprecated property, Please use 'address_family' instead.		 string Deprecated
filter_in_routemap_id RouteMap to be used for IN direction filter for IPV4_UNICAST address family

This is a deprecated property, Please use 'address_family' instead.		 string Deprecated
filter_out_ipprefixlist_id IPPrefixList to be used for OUT direction filter for IPV4_UNICAST address family

This is a deprecated property, Please use 'address_family' instead.		 string Deprecated
filter_out_routemap_id RouteMap to be used for OUT direction filter for IPV4_UNICAST address family

This is a deprecated property, Please use 'address_family' instead.		 string Deprecated
hold_down_timer Wait period (seconds) before declaring peer dead integer Minimum: 1
Maximum: 65535
Default: "180"
id Unique identifier of this resource string Readonly
Sortable
keep_alive_timer Frequency (seconds) with which keep alive messages are sent to peers integer Minimum: 1
Maximum: 65535
Default: "60"
logical_router_id Logical router id string Readonly
maximum_hop_limit Maximum Number of hops allowed to reach BGP neighbor

This value is set on TTL(time to live) of BGP header.
When router receives the BGP packet, it decrements the TTL. The default
value of TTL is one when BPG request is initiated.So in the case of a
BGP peer multiple hops away and and value of TTL is one, then next
router in the path will decrement the TTL to 0, realize it cant forward
the packet and will drop it. If the hop count value to reach neighbor
is equal to or less than the maximum_hop_limit value then intermediate
router decrements the TTL count by one and forwards the request to
BGP neighour. If the hop count value is greater than the maximum_hop_limit
value then intermediate router discards the request when TTL becomes 0.
int Minimum: 1
Maximum: 255
Default: "1"
neighbor_address Neighbor IP Address IPv4Address Required
password Password

User can create (POST) the neighbor with or without the password.
The view (GET) on the neighbor, would never reveal if the password is set or not.
The password can be set later using edit neighbor workFlow (PUT)
On the edit neighbor (PUT), if the user does not specify the password property, the
older value is retained. Maximum length of this field is 20 characters.
string Minimum length: 1
remote_as Autonomous System Number of the neighbor

This is a deprecated property, Please use 'remote_as_num' instead.		 integer Deprecated
Minimum: 1
Maximum: 4294967296
remote_as_num 4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format string
resource_type Must be set to the value BgpNeighbor string
source_address Logical Router Uplink IP Address

Deprecated - do not provide a value for this field. Use source_addresses instead.		 IPv4Address Deprecated
source_addresses Array of Logical Router Uplink IP Addresses

BGP neighborship will be formed from all these source addresses to this neighbour.		 array of IPv4Address Maximum items: 8
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BgpNeighborAddressFamily (schema)

Name Description Type Notes
enabled Enable this address family boolean Default: "True"
in_filter_ipprefixlist_id Id of the IPPrefix List to be used for IN direction filter string
in_filter_routemap_id Id of the RouteMap to be used for IN direction filter string
out_filter_ipprefixlist_id Id of the IPPrefixList to be used for OUT direction filter string
out_filter_routemap_id Id of the RouteMap to be used for OUT direction filter string
type Address family type AddressFamilyType Required

BgpNeighborListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paginated list of bgp neighbors array of BgpNeighbor Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

BgpNeighborStatus (schema)

Name Description Type Notes
announced_capabilities BGP capabilities sent to BGP neighbor. array of string Readonly
connection_drop_count Count of connection drop integer Readonly
connection_state Current state of the BGP session. string Readonly
Enum: INVALID, IDLE, CONNECT, ACTIVE, OPEN_SENT, OPEN_CONFIRM, ESTABLISHED
established_connection_count Count of connections established integer Readonly
graceful_restart Indicate current state of graceful restart where graceful_restart = true indicate graceful restart is enabled and graceful_restart = false indicate graceful restart is disabled. boolean Readonly
hold_time 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. integer Readonly
keep_alive_interval Time in ms to wait for HELLO packet from BGP peer integer Readonly
local_port TCP port number of Local BGP connection integer Readonly
Minimum: 1
Maximum: 65535
lr_component_id Logical router component(Service Router/Distributed Router) id string Required
Readonly
messages_received Count of messages received from the neighbor integer Readonly
messages_sent Count of messages sent to the neighbor integer Readonly
negotiated_capability BGP capabilities negotiated with BGP neighbor. array of string Readonly
neighbor_address The IP of the BGP neighbor IPAddress Readonly
neighbor_router_id Router ID of the BGP neighbor. IPAddress Readonly
remote_as_number AS number of the BGP neighbor string Readonly
remote_port TCP port number of remote BGP Connection integer Readonly
Minimum: 1
Maximum: 65535
source_address The Ip address of logical port IPAddress Readonly
time_since_established Time(in milliseconds) since connection was established. integer Readonly
total_in_prefix_count Count of in prefixes integer Readonly
total_out_prefix_count Count of out prefixes integer Readonly
transport_node Transport node id and name ResourceReference Readonly

BgpNeighborsStatusListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_update_timestamp Timestamp indicating last update time of data

Timestamp when the data was last updated, unset if data source has never updated the data.		 EpochMsTimestamp Readonly
logical_router_id Logical router id string Required
Readonly
logical_router_name Name of the logical router string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Status of BGP neighbors of the logical router array of BgpNeighborStatus Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

BgpRouteAggregation (schema)

Name Description Type Notes
prefix cidr of the aggregate address IPv4CIDRBlock Required
summary_only Flag to send only summarized route boolean Default: "True"

BlackholeAction (schema)

Action to be taken on matching packets for NULL routes. For action is DISCARD, matching packets are dropped rather than forwarded.

Name Description Type Notes
BlackholeAction Action to be taken on matching packets for NULL routes. For action is DISCARD, matching packets are dropped rather than forwarded. string Enum: DISCARD

BpduFilter (schema)

BPDU filter configuration

Name Description Type Notes
enabled Indicates whether BPDU filter is enabled boolean Required
white_list Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering array of string Minimum items: 0
Maximum items: 32

BridgeCluster (schema)

Bridge Cluster

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
bridge_nodes Nodes used in bridging array of BridgeClusterNode Required
Maximum items: 2
cluster_profile_bindings Bridge cluster profile bindings array of ClusterProfileTypeIdEntry
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value BridgeCluster string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BridgeClusterListResult (schema)

Bridge cluster queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results BridgeCluster Results array of BridgeCluster Required
Readonly
Minimum items: 0
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

BridgeClusterNode (schema)

Bridge transport node

Name Description Type Notes
ha_mac MAC address used for HA protocol MACAddress Readonly
transport_node_id UUID of the transport node string Required
Maximum length: 36

BridgeEndpoint (schema)

Bridge Endpoint

A bridge endpoint can be created on a bridge cluster or on an edge
cluster. Few of the properties of this class will not be used depending on
the type of bridge endpoint being created. When creating a bridge endpoint
on a bridge cluster, following propeties will be used: vlan,
bridge_cluster_id and ha_enable. Similarly, for creating a bridge endpoint
on an edge cluster following properties will be used: vlan,
bridge_endpoint_profile_id and vlan_transport_zone_id.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
bridge_cluster_id UUID of the bridge cluster for this bridge endpoint

This field will not be used if an edge cluster is being used for the
bridge endpoint
string Maximum length: 36
bridge_endpoint_profile_id Bridge endpoint profile used by the edge cluster

This field will not be used if a bridge cluster is being used for the
bridge endpoint
string
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
ha_enable Controls the enabling of HA on the VLAN for this endpoint

This field will not be used if an edge cluster is being used for the
bridge endpoint
boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value BridgeEndpoint string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vlan VlanID Required
vlan_transport_zone_id VLAN transport zone id by the edge cluster

This field will not be used if a bridge cluster is being used for the
bridge endpoint
string

BridgeEndpointListResult (schema)

Bridge Endpoint queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results BridgeEndpoint Results array of BridgeEndpoint Required
Readonly
Minimum items: 0
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

BridgeEndpointProfile (schema)

Bridge Endpoint Profile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
edge_cluster_id UUID of the edge cluster for this bridge endpoint string Required
Maximum length: 36
edge_cluster_member_indexes Indexes of the member hosts of the edge bridge cluster

First index will be used as the preferred member		 array of int
failover_mode Failover mode for the edge bridge cluster

Faileover mode can be preemmptive or non-preemptive		 string Enum: PREEMPTIVE, NON_PREEMPTIVE
Default: "PREEMPTIVE"
high_availability_mode High availability mode for the edge bridge cluster

High avaialability mode can be active-active or active-standby		 string Enum: ACTIVE_STANDBY
Default: "ACTIVE_STANDBY"
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value BridgeEndpointProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

BridgeEndpointProfileListResult (schema)

Bridge Endpoint Profile queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results BridgeEndpointProfile Results array of BridgeEndpointProfile Required
Readonly
Minimum items: 0
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

BridgeEndpointProfileRequestParameters (schema)

Bridge Endpoint Profile request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
edge_cluster_id Edge Cluster Identifier string
failover_mode string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

BridgeEndpointRequestParameters (schema)

Bridge Endpoint request parameters

When querying for bridge endpoints on a bridge cluster, following
parameters can be used: bridge_cluster_id and logical_switch_id. When
querying for bridge endpoints on an edge cluster, following parameters
can be used: bridge_endpoint_profile_id, vlan_transport_zone_id and
logical_switch_id. When multiple parameters are provided they will be
anded together. if bridge_cluster_id is used along with
bridge_endpoint_profile_id or vlan_transport_zone_id an error will be
thrown.

Name Description Type Notes
bridge_cluster_id Bridge Cluster Identifier

If provided, only bridge endpoints associated with the given bridge
cluster will be returned.
string
bridge_endpoint_profile_id Bridge endpoint profile used by the edge cluster

If provided, only bridge endpoints associated with the given bridge
endpoint profile will be returned.
string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
logical_switch_id Logical Switch Identifier

If provided, only bridge endpoints associated with the given logical
switch will be returned.
string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
vlan_transport_zone_id VLAN transport zone id used by the edge cluster

If provided, only bridge endpoints associated with the given transport
zone will be returned.
string

BridgeHighAvailabilityClusterProfile (schema)

Profile for BFD HA cluster setting

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
bfd_probe_interval the time interval (in millisec) between probe packets for heartbeat purpose integer Minimum: 300
Maximum: 60000
Default: "1000"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enable whether the heartbeat is enabled boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value BridgeHighAvailabilityClusterProfile ClusterProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ByodServiceInstance (schema)

Custom Instance of a service

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
deployment_mode Deployment Mode

Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.		 string Required
Enum: STAND_ALONE, ACTIVE_STANDBY
Default: "ACTIVE_STANDBY"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
on_failure_policy On Failure Policy

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.		 string Enum: ALLOW, BLOCK
resource_type Must be set to the value ByodServiceInstance ServiceInstanceResourceType Required
service_id Service Id

The Service to which the service instance is associated.		 string Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_type Transport Type

Transport to be used by this service instance for deploying the Service-VM.		 string Required
Enum: L2_BRIDGE, L3_ROUTED

CCPUpgradeStatus (schema)

Status of CCP upgrade

Name Description Type Notes
can_skip Can the upgrade of the remaining units in this component be skipped boolean Readonly
component_type Component type for the upgrade status string Readonly
details Details about the upgrade status string Readonly
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
status Upgrade status of component string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

CapacityUsage (schema)

usage of each capacity type ex. vm, cpu

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
capacity_type type of the capacity field string Readonly
usage_count count of number of items of capacity_type integer Readonly

Certificate (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
details list of X509Certificates array of X509Certificate Readonly
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
pem_encoded pem encoded certificate data string Required
resource_type Must be set to the value Certificate string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
used_by list of node IDs with services, that are using this certificate array of NodeIdServicesMap Readonly

CertificateId (schema)

Name Description Type Notes
certificate_id Certificate ID string Required
Readonly

CertificateList (schema)

Certificate queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Certificate list array of Certificate Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

CidrBlock (schema)

IPv4 CIDR Block

Stores information about IPv4 CIDR block.

Name Description Type Notes
CidrBlock IPv4 CIDR Block

Stores information about IPv4 CIDR block.		 string

CipherSuite (schema)

HTTP cipher suite

Name Description Type Notes
enabled Enable status for this cipher suite boolean Required
name Name of the TLS cipher suite string Required

ClasslessStaticRoute (schema)

Name Description Type Notes
network destination in cidr IPElement Required
next_hop router IPAddress Required

ClientAuthType (schema)

client authentication mode

Client authentication could be REQUIRED or IGNORE.
REQUIRED means that client is required to present its
certificate to the server for authentication. To be accepted, client
certificate must be signed by one of the trusted Certificate
Authorities (CAs), also referred to as root CAs, whose self signed
certificates are specified in the same client SSL profile binding.
IGNORE means that client certificate would be ignored.

Name Description Type Notes
ClientAuthType client authentication mode

Client authentication could be REQUIRED or IGNORE.
REQUIRED means that client is required to present its
certificate to the server for authentication. To be accepted, client
certificate must be signed by one of the trusted Certificate
Authorities (CAs), also referred to as root CAs, whose self signed
certificates are specified in the same client SSL profile binding.
IGNORE means that client certificate would be ignored.
string Enum: REQUIRED, IGNORE

ClientSslProfileBinding (schema)

Name Description Type Notes
certificate_chain_depth the maximum traversal depth of client certificate chain

authentication depth is used to set the verification depth in the client
certificates chain.
integer Minimum: 1
Maximum: 2147483647
Default: "3"
client_auth client authentication mode ClientAuthType Default: "IGNORE"
client_auth_ca_ids CA identifier list to verify client certificate

If client auth type is REQUIRED, client certificate must be signed by
one of the trusted Certificate Authorities (CAs), also referred to as
root CAs, whose self signed certificates are specified.
array of string
client_auth_crl_ids CRL identifier list to verify client certificate

A Certificate Revocation List (CRL) can be specified in the client-side
SSL profile binding to disallow compromised client certificates.
array of string
default_certificate_id default service certificate identifier

A default certificate should be specified which will be used if the
server does not host multiple hostnames on the same IP address or if
the client does not support SNI extension.
string Required
sni_certificate_ids SNI certificate identifier list

Client-side SSL profile binding allows multiple certificates, for
different hostnames, to be bound to the same virtual server.
array of string
ssl_profile_id client SSL profile identifier

Client SSL profile defines reusable, application-independent client side
SSL properties.
string

ClientTypeCollectionConfiguration (schema)

HPM client data collection configuration

Name Description Type Notes
client_type Client Type

The client type for which this data collection frequency setting applies		 string Required
Enum: HYPERVISOR, EDGE, CONTROL_PLANE, CONTROL_PLANE_PLATFORM, MANAGEMENT_PLANE, MANAGEMENT_PLANE_PLATFORM
data_type_configurations Data type configurations

The set of data collection type configurations, one for each data collection type		 array of DataTypeCollectionConfiguration Required

CloudAccount (schema)

Cloud Account

Stores information about a cloud account like cloud type and insatnce
statistics.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
auth_users Authrized Users

List of authorized users.		 array of CloudUserInfo Readonly
cloud_tags_enabled Boolean flag to enable or disable cloud tags discovery

Boolean flag to enable or disable cloud tags discovery. The discovered
cloud tags can be used to define security group membership.
boolean Default: "True"
cloud_type Cloud Type string Required
Enum: AWS, AZURE, GOOGLE
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
instance_stats Instance statistics

Stores statistics of the number of managed, unmanaged and error virtual
machines.
InstanceStats Readonly
resource_type Must be set to the value CloudAccount string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tenant_id Tenant ID

Tenant ID of the cloud account.		 string Readonly

CloudAccountStatus (schema)

Cloud Account status

Stores the status of cloud account like credentials validity status and
inventory synchronization status.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
credentials_status Credentials Status

Status of the cloud account credentials synced at the auto interval.
string Readonly
Enum: VALID, INVALID
inventory_sync_status Inventory Synchronization Status

Status of inventory synchronization process.		 string Readonly
Enum: SYNCED, IN_PROGRESS

CloudSecurityGroup (schema)

Cloud Security Group

Stores cloud security group information.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
security_group_id Security Group ID

ID of the cloud security group.
string
security_group_name Security Group Name

Name of the cloud security group.
string

CloudTag (schema)

Cloud Tag

Stores the key-value pair of cloud tag

Name Description Type Notes
key Tag key

Key of the tag		 string Readonly
value Tag value

Value of the tag		 string Readonly

CloudTypeInfo (schema)

Cloud Type information

Name Description Type Notes
cloud_type Cloud Type

Name of the cloud vendor.		 string Readonly

CloudUserInfo (schema)

User information

Name Description Type Notes
display_name Display name of the user string Readonly
id ID of the user string Readonly

CloudVirtualMachine (schema)

Cloud Virtual Machine Information

Stores information about a Virtual Machine

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
agent_status Agent Status string Readonly
Enum: UP, DOWN, NO_AGENT
agent_version Agent version details string Readonly
associated_account_ids Associated Cloud Account IDs

Array of associated cloud account IDs.		 array of string
cloud_tags Cloud tags for the virtual machine array of CloudTag Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
error_messages List of error messages

List of error messages identified. Returns only error messages
identified in the last 1 hour.
array of ComputeInstanceErrorMessage Readonly
gateway_ha_index Gateway HA Index

Index of HA that indicates whether gateway is primary or secondary.
If index is 0, then it is primary gateway. Else secondary gateway.
integer
gateway_status Gateway Status string Readonly
Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING
id Unique identifier of this resource string Readonly
Sortable
is_gateway Flag to identify if this VM is a gateway node boolean Readonly
is_gateway_active Flag to identify if this VM is an active gateway node boolean Readonly
logical_switch_display_name Logical Switch display name string Readonly
logical_switch_id Logical Switch ID string Readonly
managed_by_nsx Indicate if vm is managed by NSX or not boolean Required
Readonly
nsx_ip IP address provided by NSX string Readonly
os_details Operating system details string Readonly
os_type Operating system of the virtual machine string Readonly
private_ip Private IP address of the virtual machine string Readonly
public_ip Public IP address of the virtual machine string Readonly
quarantine_state Quarantine State

Indicates the quarantine state of the VM.
QUARANTINED - This state implies VM is moved to quarantine security
group because some threat has been detected.
NOT_QUARANTINED - This state implies no quarantine action has been
taken.
UNKNOWN - This state implies either quarantine policy is disabled or
quarantine information is not available.
OVERRIDDEN - This state implies VM is associated with vm_override_sg
which overrides any action based on threat detection.
string Readonly
Enum: QUARANTINED, NOT_QUARANTINED, UNKNOWN, OVERRIDDEN
resource_type Must be set to the value CloudVirtualMachine string Required
Enum: AwsVirtualMachine, AzureVirtualMachine
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
threat_state Threat State

Indicates the threat state of the VM.
NORMAL - This state implies no threat has been detected and VM is
functioning as expected.
THREAT - This state implies quarantine enabling threat has been
detected.
INVALID - This state implies either VM is unmanaged or threat related
information is not available.
string Readonly
Enum: NORMAL, THREAT, INVALID
vm_extension_execution_status VM extension script execution status

UNKNOWN - This is the default state. Indicates no information available
regarding extension execution. This can potentially occur for
a VM when agent is installed out of band or if
cloud_agent_automated_install_enabled flag is enabled for the
VNET/VPC which already has managed VMs.
SUCCESSFUL - Indicates VM extension script execution was successful.
This does not necessarily mean agent installation was
successful.
FAILED - Indicates VM extension script execution failed.
string Readonly

CloudVirtualMachinesListRequestParameters (schema)

Cloud Virtual Machines List Request Parameters

A set of optional filter parameters to list cloud virtual machines

Name Description Type Notes
account_id Account ID

Optional identifier for account based on which virtual machines are to
be filtered
string
cloud_type Cloud Type

Optional identifier for cloud provider based on which Virtual Machines
are to be filtered
string Enum: AWS, AZURE
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
instance_id Instance ID

Optional identifier for virtual machine based on which the list can be
filtered
string
is_gateway Is the VM a gateway node?

Optional identifier based on which only gateway Virtual Machines can be
filtered
boolean
logical_switch_id Logical Switch ID

Optional identifier for logical switch based on which Aws Virtual
Machines are to be filtered
string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
public_ip Public IP address of the virtual machine

Optional identifier for public IP based on which Virtual Machines are
to be filtered
string
quarantine_state Quarantine State

Identifier for quarantine state based on which Virtual Machines are to
be filtered.
QUARANTINED - This state implies VM is moved to quarantine security
group because some threat has been detected.
NOT_QUARANTINED - This state implies no quarantine action has been
taken.
UNKNOWN - This state implies either quarantine policy is disabled or
quarantine information is not available.
OVERRIDDEN - This state implies VM is associated with vm_override_sg
which overrides any action based on threat detection.
string Readonly
Enum: QUARANTINED, NOT_QUARANTINED, UNKNOWN, OVERRIDDEN
region_id Region ID

Optional identifier for AWS or Azure region based on which Virtual
Machines are to be filtered
string
resource_type Resource Type

Optional identifier for listing virtual machines of a particular cloud
provider. Possible values are in the form of VirtualMachine prefixed by
cloud name. For example, AwsVirtualMachine or AzureVirtualMachine.
string Enum: AwsVirtualMachine, AzureVirtualMachine
sort_ascending boolean
sort_by Field by which records are sorted string
vnet_id Azure virtual network ID

Optional identifier for Azure virtual network based on which Azure
Virtual Machines are to be filtered. It consists of resourceGuid of Azure Vnet.
string
vpc_id AWS VPC ID

Optional identifier for AWS VPC based on which Virtual Machines are to
be filtered
string

CloudVirtualMachinesListResult (schema)

Cloud Virtual Machines List Result

Stores a list of cloud virtual machines

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of cloud virtual machines		 array of CloudVirtualMachine
(Abstract type: pass one of the following concrete types)
AwsVirtualMachine
AzureVirtualMachine
CloudVirtualMachine
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ClusterBackupInfo (schema)

Cluster backup details

Name Description Type Notes
ip_address IP address of the node from which the backup was taken IPAddress Required
Readonly
node_id ID of the node from which the backup was taken string Required
Readonly
timestamp timestamp of the cluster backup file EpochMsTimestamp Required
Readonly

ClusterBackupInfoListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of timestamps of backed-up cluster files array of ClusterBackupInfo Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ClusterConfig (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cluster_id Unique identifier of this cluster string Readonly
control_cluster_changes_allowed True if control cluster nodes may be added or removed boolean Required
mgmt_cluster_changes_allowed True if management cluster nodes may be added or removed boolean Required

ClusterGroupMemberStatus (schema)

Status of a group member

This type contains the attributes and status of a group member.

Name Description Type Notes
member_name Name of the group member string Readonly
member_status Status of the group member string Readonly
Enum: UP, DOWN, UNKNOWN
member_uuid UUID of the group member string Readonly

ClusterGroupServiceLeader (schema)

Leader for a service of the group

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.

Name Description Type Notes
leader_uuid Member UUID of the leader string Readonly
lease_version Number of times the lease has been renewed integer Readonly
service_name Name of the service string Readonly

ClusterGroupStatus (schema)

Status of a group

This type contains the attributes and status of a group.

Name Description Type Notes
group_id UUID of the group string Readonly
group_status Group status string Readonly
Enum: STABLE, DEGRADED, UNSTABLE, UNAVAILABLE
group_type Type of the group string Readonly
Enum: MANAGER, CONTROLLER, POLICY, HTTP
leaders Array of group leaders and their attributes array of ClusterGroupServiceLeader Readonly
members Array of group members and their statuses array of ClusterGroupMemberStatus Readonly

ClusterInitializationNodeInfo (schema)

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).

Name Description Type Notes
disk_store_id The (internal) disk-store ID of the member string Readonly
host_address The IP address (or domain name) of the cluster node string Readonly

ClusterNodeConfig (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
appliance_mgmt_listen_addr The IP and port for the appliance management API service on this node string Readonly
controller_role ControllerClusterRoleConfig
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id Internal identifier provided by the node string Readonly
id Unique identifier of this resource string Readonly
Sortable
manager_role ManagementClusterRoleConfig
resource_type Must be set to the value ClusterNodeConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ClusterNodeConfigListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Cluster node configuration results array of ClusterNodeConfig Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ClusterNodeRole (schema)

Cluster node role

Enumerates the types of cluster nodes for which VM auto-deployment is
currently supported.

Name Description Type Notes
ClusterNodeRole Cluster node role

Enumerates the types of cluster nodes for which VM auto-deployment is
currently supported.
string Enum: CONTROLLER, MANAGER

ClusterNodeStatus (schema)

Name Description Type Notes
control_cluster_status Clustering status for control plane functions on this node ControlClusterNodeStatus Readonly
mgmt_cluster_status Clustering status for management plane functions on this node ManagementClusterNodeStatus Readonly
system_status Node status properties NodeStatusProperties Readonly
version Software version running on node string Readonly

ClusterNodeVMDeploymentConfig (schema)

Configuration for deploying cluster node VM

Contains info used to configure the VM on deployment

Name Description Type Notes
placement_type Type of deployment

Specifies the config for the platform through which to deploy the VM
string Required
Enum: VsphereClusterNodeVMDeploymentConfig

ClusterNodeVMDeploymentRequest (schema)

Info for an auto-deployment request

Contains the deployment information for a cluster node VM soon to be
deployed or already deployed by the Manager

Name Description Type Notes
deployment_config Deployment config for cluster node VM

Info needed to configure a cluster node VM at deployment for a
specific platform.
May require different parameters depending on the method used to deploy
the VM.
ClusterNodeVMDeploymentConfig
(Abstract type: pass one of the following concrete types)
ClusterNodeVMDeploymentConfig
VsphereClusterNodeVMDeploymentConfig		 Required
form_factor Form factor for cluster node VMs

Specifies the desired "size" of the VM
Note: MEDIUM is currently the only supported size for controllers.
ClusterNodeVMFormFactor Default: "MEDIUM"
roles Cluster node roles of the VM

List of cluster node role (or roles) which the VM should take on.
They specify what type (or types) of cluster node which the new VM
should act as.
array of ClusterNodeRole Required
user_settings User settings for the VM

Username and password settings for the cluster node VM.
Note: These settings will be honored only during VM deployment.
Post-deployment, CLI must be used for changing the user settings and
changes to these parameters will not have any effect.
NodeUserSettings Required
vm_id ID of VM used to recognize it

ID of the VM maintained internally and used to recognize it.
Note: This is automatically generated and cannot be modified.
string Readonly

ClusterNodeVMDeploymentRequestList (schema)

ClusterNodeVMDeploymentRequest list

List of ClusterNodeVMDeploymentRequests

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of existing ClusterNodeVMDeploymentRequests
array of ClusterNodeVMDeploymentRequest Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ClusterNodeVMFormFactor (schema)

Supported VM form factor for cluster nodes

Specifies the desired "size" of the VM. Affects number of virtual CPUs
and/or memory size given to the new cluster node VM.
IMPORTANT: MEDIUM is currently the only supported size for controllers.

Name Description Type Notes
ClusterNodeVMFormFactor Supported VM form factor for cluster nodes

Specifies the desired "size" of the VM. Affects number of virtual CPUs
and/or memory size given to the new cluster node VM.
IMPORTANT: MEDIUM is currently the only supported size for controllers.
string Enum: SMALL, MEDIUM, MEDIUM_LARGE, LARGE

ClusterProfile (schema)

This is an abstract type. Concrete child types:
BridgeHighAvailabilityClusterProfile
EdgeHighAvailabilityProfile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value ClusterProfile ClusterProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ClusterProfileListParameters (schema)

ClusterProfile List Parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
include_system_owned Whether the list result contains system resources boolean Default: "True"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_type Type of cluster profile ClusterProfileType
sort_ascending boolean
sort_by Field by which records are sorted string

ClusterProfileListResult (schema)

Cluster Profile queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Cluster Profile Results array of ClusterProfile
(Abstract type: pass one of the following concrete types)
BridgeHighAvailabilityClusterProfile
EdgeHighAvailabilityProfile		 Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ClusterProfileType (schema)

Supported cluster profiles.

Name Description Type Notes
ClusterProfileType Supported cluster profiles. string Enum: EdgeHighAvailabilityProfile, BridgeHighAvailabilityClusterProfile

ClusterProfileTypeIdEntry (schema)

Name Description Type Notes
profile_id key value string Required
resource_type ClusterProfileType

ClusterRestoreStatus (schema)

Cluster restore status

Name Description Type Notes
backup_timestamp Timestamp when backup was initiated in epoch millisecond EpochMsTimestamp Required
Readonly
endpoints The list of allowed endpoints, based on the current state of the restore process array of ResourceLink Required
Readonly
id Unique id for backup request string Required
Readonly
instructions Instructions for users to reconcile Restore operations array of InstructionInfo Readonly
restore_end_time Timestamp when restore was completed in epoch millisecond EpochMsTimestamp Readonly
restore_start_time Timestamp when restore was started in epoch millisecond EpochMsTimestamp Readonly
status GlobalRestoreStatus
step RestoreStep
total_steps Total number of steps in the entire restore process integer Required
Readonly

ClusterRoleConfig (schema)

Name Description Type Notes
type Type of this role configuration string Required
Readonly
Enum: ManagementClusterRoleConfig, ControllerClusterRoleConfig

ClusterStatus (schema)

Name Description Type Notes
cluster_id Unique identifier of this cluster string Readonly
control_cluster_status The current status of the control cluster ControllerClusterStatus Readonly
mgmt_cluster_status The current status of the management cluster ManagementClusterStatus Readonly

ClusteringInfo (schema)

Clustering parameters for the controller cluster

Name Description Type Notes
join_to_existing_cluster True If the controller node should join an existing cluster

Property to indicate if the node must join an existing cluster.		 boolean Required
shared_secret Shared Secret of the cluster

Shared secret of the cluster.		 string Required

ClusteringStatus (schema)

Name Description Type Notes
ClusteringStatus string Enum: CONNECTED, DISCONNECTED, UNKNOWN

ClustersAggregateInfo (schema)

Name Description Type Notes
cluster_status Status of all the cluster groups AllClusterGroupStatus Required
controller_cluster Array of Controller Nodes array of ControllerNodeAggregateInfo Required
management_cluster Array of Management Nodes array of ManagementNodeAggregateInfo Required

ColumnItem (schema)

Grid Column

Represents a column of the Grid

Name Description Type Notes
column_identifier Identifier for this column

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.		 string
drilldown_id Id of drilldown widget

Id of drilldown widget, if any. Id should be a valid id of an existing widget.		 string Maximum length: 255
field Column Field

Field from which values of the column will be derived.		 string Required
Maximum length: 1024
hidden Hide the column

If set to true, hides the column		 boolean Default: "False"
label Column Label

Label of the column.		 Label Required
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.		 string Maximum length: 1024
render_configuration Render Configuration

Render configuration to be applied, if any.		 array of RenderConfiguration
sort_ascending Represents order of sorting the values

If true, the value of the column are sorted in ascending order. Otherwise, in descending order.		 boolean Default: "True"
sort_key Key for sorting on this column

Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.		 string Maximum length: 255
tooltip Multi-line tooltip

Multi-line text to be shown on tooltip while hovering over a cell in the grid.		 array of Tooltip
type Field data type

Data type of the field.		 string Required
Enum: String, Number, Date
Maximum length: 255
Default: "String"

CommunityMatchExpression (schema)

Community match expression

Name Description Type Notes
expression Array of community match operations array of CommunityMatchOperation Required
operator Operator

Operator for evaluating community match expressions.
AND logical AND operator
string Readonly
Enum: AND

CommunityMatchOperation (schema)

Community match operation

Name Description Type Notes
community_list_id Community list id

ID of BGP community list. This value is not required when
match_operator is MATCH_REGEX otherwise required.
string
match_operator Match operator

Match operator for communities from provided community list id.
MATCH_ANY will match any community
MATCH_ALL will match all communities
MATCH_EXACT will do exact match on community
MATCH_NONE will not match any community
MATCH_REGEX will match community by evaluating regular
expression
string Enum: MATCH_ANY, MATCH_ALL, MATCH_EXACT, MATCH_NONE, MATCH_REGEX
Default: "MATCH_ANY"
regular_expression Regular expression

Regular expression to match BGP communities. If match_operator
is MATCH_REGEX then this value must be specified.
string

ComponentTargetVersion (schema)

Name Description Type Notes
component_type string Required
Readonly
target_version string Required
Readonly

ComponentTypeListRequestParameters (schema)

Name Description Type Notes
component_type Component type based on which upgrade unit groups to be filtered string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

ComponentUpgradeStatus (schema)

Name Description Type Notes
can_skip Can the upgrade of the remaining units in this component be skipped boolean Readonly
component_type Component type for the upgrade status string Readonly
details Details about the upgrade status string Readonly
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
status Upgrade status of component string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

ComputeCollection (schema)

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cm_local_id Local Id of the compute collection in the Compute Manager string Required
Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC string Required
Readonly
origin_id Id of the compute manager from where this Compute Collection was discovered string Required
Readonly
origin_properties Key-Value map of additional specific properties of compute collection in the Compute Manager array of KeyValuePair Readonly
origin_type ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers string Required
Readonly
owner_id Id of the owner of compute collection in the Compute Manager string Readonly
resource_type Must be set to the value ComputeCollection string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ComputeCollectionFabricTemplate (schema)

Compute collection fabric template

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
auto_install_nsx Flag to enable/disable automatic install of NSX components

Indicates whether NSX components should be automcatically installed. When 'true' NSX components will be automatically installed on the new host added to compute collection.		 boolean Required
compute_collection_id Associated compute collection id string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value ComputeCollectionFabricTemplate string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ComputeCollectionFabricTemplateListResult (schema)

List of compute collection fabric template

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of compute collection fabric template array of ComputeCollectionFabricTemplate Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ComputeCollectionListRequestParameters (schema)

Compute Collection list parameters

Name Description Type Notes
cm_local_id Local Id of the compute collection in the Compute Manager string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
discovered_node_id Id of the discovered node which belongs to this Compute Collection string
display_name Name of the ComputeCollection in source compute manager string
external_id External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC string
included_fields Comma separated list of fields that should be included in query result string
node_id Id of the fabric node created from a discovered node belonging to this Compute Collection string
origin_id Id of the compute manager from where this Compute Collection was discovered string
origin_type ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers string
owner_id Id of the owner of compute collection in the Compute Manager string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

ComputeCollectionListResult (schema)

Compute Collection list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Compute Collection list results array of ComputeCollection Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ComputeCollectionNetworkInterfacesListResult (schema)

ComputeCollection Interfaces List Result

List of network interfaces for all discovered nodes in compute collection

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Discovered node network interfaces

List of discovered node with network interfaces		 array of DiscoveredNodeNetworkInterfaces Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ComputeCollectionTransportNodeTemplate (schema)

Compute collection transport node template

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
compute_collection_ids Associated compute collection ids array of string Required
Minimum items: 1
Maximum items: 1
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
host_switch_spec Transport node host switch specification

Property 'host_switch_spec' can be used to create either standard host switch or preconfigured host switch.		 HostSwitchSpec
(Abstract type: pass one of the following concrete types)
PreconfiguredHostSwitchSpec
StandardHostSwitchSpec
id Unique identifier of this resource string Readonly
Sortable
network_migration_spec_ids Id(s) of Network migration specifications to be linked to compute collections

Property 'network_migration_spec_ids' should only be used for compute collections which are clusters in VMware vCenter. Currently only HostProfileNetworkMigrationSpec type is supported. This specification will only apply to Stateless ESX hosts which are under this vCenter cluster.		 array of NetworkMigrationSpecTypeIdEntry Maximum items: 1
resource_type Must be set to the value ComputeCollectionTransportNodeTemplate string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_zone_endpoints Transport zone endpoints array of TransportZoneEndPoint

ComputeCollectionTransportNodeTemplateState (schema)

Transport node state per compute collection

Name Description Type Notes
compute_collection_id Associated compute collection id string Readonly
template_states Transport node template states in compute collection array of TransportNodeTemplateState Readonly

ComputeCollectionTransportNodeTemplateStateList (schema)

Transport node creation state list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results State list per compute collection array of ComputeCollectionTransportNodeTemplateState Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ComputeInstanceErrorMessage (schema)

Compute Instance Error Message

Stores an error ID and error message

Name Description Type Notes
detailed_message Error details

Error message string to indicate, if it is NSX or cloud operation generated error.		 string Required
Readonly
error_id An error ID contract obtained from PCM integer Required
Readonly

ComputeManager (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
credential Login credentials for the compute manager LoginCredential
(Abstract type: pass one of the following concrete types)
LoginCredential
UsernamePasswordLoginCredential
VerifiableAsymmetricLoginCredential
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
origin_properties Key-Value map of additional specific properties of compute manager array of KeyValuePair Readonly
origin_type Compute manager type like vCenter string Required
resource_type Must be set to the value ComputeManager string
server IP address or hostname of compute manager string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ComputeManagerListRequestParameters (schema)

Compute manager list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
origin_type Compute manager type like vCenter string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
server IP address or hostname of compute manager string
sort_ascending boolean
sort_by Field by which records are sorted string

ComputeManagerListResult (schema)

List of compute managers

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of compute managers array of ComputeManager Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ConditionalForwarderZone (schema)

Name Description Type Notes
domain_names Domain names of a forwarder zone

A forwarder domain name should be a valid FQDN. If reverse lookup is
needed for this zone, reverse lookup domain name like X.in-addr.arpa
can be defined. Here the X represents a subnet.
array of string Required
Minimum items: 1
Maximum items: 100
source_ip Source ip of the forwarder

The source ip used by the fowarder of the zone. If no source ip
specified, the ip address of listener of the dns forwarder will
be used.
IPv4Address
upstream_servers Ips of upsteam dns servers

Ip address of the upstream dns servers the dns forwarder accesses.
array of IPv4Address Required
Minimum items: 1
Maximum items: 3

ConfigurationState (schema)

Describes status of configuration of an entity

Name Description Type Notes
details Array of configuration state of various sub systems array of ConfigurationStateElement Readonly
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
state Overall state of desired configuration

Gives details of state of desired configuration		 string Required
Readonly
Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown

ConfigurationStateElement (schema)

Describes status of configuration of an entity

Name Description Type Notes
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
state State of configuration on this sub system string Required
Readonly
Enum: in_progress, success, failed, partial_success
sub_system_address URI of backing resource on sub system string Readonly
sub_system_id Identifier of backing resource on sub system string Readonly
sub_system_type Type of backing resource on sub system string Readonly

ContainerConfiguration (schema)

Container that holds widgets

Represents a container to group widgets that belong to a common category or have a common purpose.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
datasources Array of Datasource Instances with their relative urls

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.		 array of Datasource Minimum items: 0
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
drilldown_id Id of drilldown widget

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.		 string Maximum length: 255
footer Footer
id Unique identifier of this resource string Readonly
Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.		 boolean Default: "False"
labels Labels

Labels for the container.		 array of Label Minimum items: 0
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details.		 string Maximum length: 1024
resource_type Must be set to the value ContainerConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration
Maximum length: 255
shared Visiblity of widgets to other users

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.		 boolean Deprecated
span Number of widgets to be held in this container horizontally

Represents the horizontal span of the container.		 int Default: "2"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.		 int Deprecated
widgets Widgets held by the container

If not specified, creates an empty container.		 array of WidgetItem Minimum items: 0

ContentFilterValue (schema)

Support bundle content filter allowed values

Name Description Type Notes
ContentFilterValue Support bundle content filter allowed values string Enum: ALL, DEFAULT

ContinueRequestParameters (schema)

Name Description Type Notes
skip Skip to upgrade of next component. boolean Default: "False"

ControlClusterNodeStatus (schema)

Name Description Type Notes
control_cluster_status Status of this node's connection to the control cluster ClusteringStatus Readonly
mgmt_connection_status Status of this node's management plane connection MgmtConnStatus Readonly

ControlConnStatus (schema)

Name Description Type Notes
control_node_ip IP address of the control Node. string Required
Readonly
failure_status Failure status of the control Node for e.g CONNECTION_REFUSED,INCOMPLETE_HOST_CERT. string Readonly
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
status Status of the control Node for e.g UP, DOWN. string Required
Readonly
Enum: UP, DOWN

ControllerClusterRoleConfig (schema)

Name Description Type Notes
control_cluster_listen_addr The IP and port for the control cluster service on this node ServiceEndpoint Readonly
control_plane_listen_addr The IP and port for the control plane service on this node ServiceEndpoint Readonly
host_msg_client_info MsgClientInfo
mpa_msg_client_info MsgClientInfo
type Type of this role configuration string Required
Readonly
Enum: ManagementClusterRoleConfig, ControllerClusterRoleConfig

ControllerClusterStatus (schema)

Name Description Type Notes
status The current status of the controller cluster string Readonly
Enum: UNSTABLE, STABLE, UNKNOWN

ControllerNodeAggregateInfo (schema)

Name Description Type Notes
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
id Unique identifier of this resource string Readonly
node_interface_properties Array of Node interface statistic properties array of NodeInterfaceProperties Readonly
node_interface_statistics Array of Node network interface statistic properties array of NodeInterfaceStatisticsProperties Readonly
node_status ClusterNodeStatus Readonly
node_status_properties Time series of the node's system properties array of NodeStatusProperties
role_config ControllerClusterRoleConfig Readonly

CookiePersistenceModeType (schema)

cookie persistence mode

If the persistence cookie is found in the incoming request, value of the
cookie is used to identify the server that this request should be sent to.
If the cookie is not found, then the server selection algorithm is used to
select a new server to handle that request.
Three different modes of cookie persistence are supported: insert, prefix
and rewrite.
In cookie insert mode, a cookie is inserted by load balancer in the HTTP
response going from server to client.
In cookie prefix and rewrite modes, server controls the cookie and load
balancer only manipulates the value of the cookie. In prefix mode, server's
cookie value is prepended with the server IP and port and then sent to the
client. In rewrite mode, entire server's cookie value is replaced with the
server IP and port in the response before sending it to the client.

Name Description Type Notes
CookiePersistenceModeType cookie persistence mode

If the persistence cookie is found in the incoming request, value of the
cookie is used to identify the server that this request should be sent to.
If the cookie is not found, then the server selection algorithm is used to
select a new server to handle that request.
Three different modes of cookie persistence are supported: insert, prefix
and rewrite.
In cookie insert mode, a cookie is inserted by load balancer in the HTTP
response going from server to client.
In cookie prefix and rewrite modes, server controls the cookie and load
balancer only manipulates the value of the cookie. In prefix mode, server's
cookie value is prepended with the server IP and port and then sent to the
client. In rewrite mode, entire server's cookie value is replaced with the
server IP and port in the response before sending it to the client.
string Enum: INSERT, PREFIX, REWRITE

CookieTimeType (schema)

Snat translation type

Both session cookie and persistence cookie are supported,
Use LbSessionCookieTime for session cookie time setting,
Use LbPersistenceCookieTime for persistence cookie time setting

Name Description Type Notes
CookieTimeType Snat translation type

Both session cookie and persistence cookie are supported,
Use LbSessionCookieTime for session cookie time setting,
Use LbPersistenceCookieTime for persistence cookie time setting
string Enum: LbSessionCookieTime, LbPersistenceCookieTime

CopyFromRemoteFileProperties (schema)

Name Description Type Notes
port Server port integer Minimum: 1
Maximum: 65535
protocol Protocol to use to copy file Protocol
(Abstract type: pass one of the following concrete types)
HttpProtocol
HttpsProtocol
ScpProtocol
SftpProtocol		 Required
server Remote server hostname or IP address string Required
Pattern: "^[^/:]+$"
uri URI of file to copy string Required

CopyRemoteFileProperties (schema)

Name Description Type Notes
port Server port integer Minimum: 1
Maximum: 65535
server Remote server hostname or IP address string Required
Pattern: "^[^/:]+$"
uri URI of file to copy string Required

CopyToRemoteFileProperties (schema)

Name Description Type Notes
port Server port integer Minimum: 1
Maximum: 65535
protocol Protocol to use to copy file

Only scp and sftp may be used.		 Protocol
(Abstract type: pass one of the following concrete types)
HttpProtocol
HttpsProtocol
ScpProtocol
SftpProtocol		 Required
server Remote server hostname or IP address string Required
Pattern: "^[^/:]+$"
uri URI of file to copy string Required

CpuCoreConfigForEnhancedNetworkingStackSwitch (schema)

Enhanced Networking Stack CPU configuration

Non Uniform Memory Access (NUMA) nodes and Logical cpu cores (Lcores) per NUMA node configuration for Enhanced Networking Stack enabled HostSwitch.

Name Description Type Notes
num_lcores Number of Logical cpu cores (Lcores) to be placed on a specified NUMA node int Required
Minimum: 1
numa_node_index Unique index of the Non Uniform Memory Access (NUMA) node int Required
Minimum: 0

CreateRemoteDirectoryProperties (schema)

Name Description Type Notes
port Server port integer Minimum: 1
Maximum: 65535
protocol Protocol to use to copy file SftpProtocol Required
server Remote server hostname or IP address string Required
Pattern: "^[^/:]+$"
uri URI of file to copy string Required

Crl (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
details details of the X509Crl object X509Crl Readonly
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
pem_encoded pem encoded crl data string Required
resource_type Must be set to the value Crl string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

CrlList (schema)

Crl queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results CRL list array of Crl Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

CrlObjectData (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
pem_encoded pem encoded crl data string Required
resource_type Must be set to the value CrlObjectData string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

CryptoAlgorithm (schema)

Name Description Type Notes
key_size supported key sizes for the algorithm array of KeySize Required
Readonly
name crypto algorithm name string Required
Readonly

CsmConfig (schema)

Information about status of cloud service manager

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
csm_appliance_status Csm appliance status string Enum: UNINITIALIZED, INITIALIZED
gateway_image_url Gateway Image URL

URL that points to JSON file containing details of gateway image.
string
single_region Specifies whether this is a single/multi region deployment

This property is used only if CSM is running in service mode		 boolean

CsmStatus (schema)

Information about status of cloud service manager

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
display_name Name of the Csm instance string Readonly
id UUID of the Csm appliance

Identifier of the Csm appliance		 string Required
Readonly
ip_address IP address of Csm instance string Readonly
managed_by_vmware Mode of running of Csm instance

This property is used only if CSM is running in service mode		 boolean Readonly
supported_clouds Indication of clouds supported by CSM

This property provides the list of names of supported clouds by CSM.
array of CloudTypeInfo Required
Readonly
version Version of Csm string Required
Readonly

Csr (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
algorithm Cryptographic algorithm(asymmetric ) used by the public key for data encryption string Required
Enum: RSA, DSA
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
key_size size measured in bits of the public key used in a cryptographic algorithm integer Required
pem_encoded pem encoded certificate data string Readonly
resource_type Must be set to the value Csr string
subject the certificate owner's information (CN, O, OU, C, ST, L) Principal Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

CsrList (schema)

Csr queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results CSR list array of Csr Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

CsvListResult (schema)

Base type for CSV result.

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string

CsvRecord (schema)

Base type for CSV records.

Name Description Type Notes
CsvRecord Base type for CSV records. object

CurrentBackupOperationStatus (schema)

Current backup operation status

Name Description Type Notes
backup_id Unique identifier of current backup string
current_step Current step of operation string Enum: BACKUP_CREATING_CLUSTER_BACKUP, BACKUP_CREATING_NODE_BACKUP
current_step_message Additional human-readable status information about current step string
end_time Time when operation is expected to end EpochMsTimestamp
operation_type Type of operation that is in progress. Returns none if no operation is in progress, in which case none of the other fields will be set. string Required
Enum: NONE, BACKUP
start_time Time when operation was started EpochMsTimestamp

DHGroup (schema)

Diffie-Hellman groups

Diffie-Hellman groups represent algorithm used to derive shared
keys between IPSec VPN initiator and responder over an
unsecured network.
GROUP2 uses 1024-bit Modular Exponentiation (MODP) group.
GROUP5 uses 1536-bit MODP group.
GROUP14 uses 2048-bit MODP group.
GROUP15 uses 3072-bit MODP group.
GROUP16 uses 4096-bit MODP group.

Name Description Type Notes
DHGroup Diffie-Hellman groups

Diffie-Hellman groups represent algorithm used to derive shared
keys between IPSec VPN initiator and responder over an
unsecured network.
GROUP2 uses 1024-bit Modular Exponentiation (MODP) group.
GROUP5 uses 1536-bit MODP group.
GROUP14 uses 2048-bit MODP group.
GROUP15 uses 3072-bit MODP group.
GROUP16 uses 4096-bit MODP group.
string Enum: GROUP2, GROUP5, GROUP14, GROUP15, GROUP16

DSAppliedToType (schema)

Resource type valid for use as AppliedTo filter in section API

Name Description Type Notes
DSAppliedToType Resource type valid for use as AppliedTo filter in section API string Enum: NSGroup, LogicalSwitch, LogicalRouter, LogicalPort

DSListRequestParameters (schema)

Parameters to filter list of sections/rules.

Pagination and Filtering parameters to get only a subset of sections/rules.

Name Description Type Notes
applied_tos AppliedTo's referenced by this section or section's Distributed Service Rules .

Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
destinations Destinations referenced by this section's Distributed Service Rules .

The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
filter_type Filter type

Filter type defines matching criteria to qualify a rule in result. Type
'FILTER' will ensure all criterias (sources, destinations, services,
appliedtos) are matched. Type 'SEARCH' will match any of the given
criteria.
string Enum: FILTER, SEARCH
Default: "FILTER"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
services NSService referenced by this section's Distributed Service Rules .

Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
sort_ascending boolean
sort_by Field by which records are sorted string
sources Sources referenced by this section's Distributed Service Rules .

The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string

DSRule (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_owner Owner of this resource OwnerResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
action Action

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).		 string Required
Enum: ALLOW, DROP, REJECT, REDIRECT, DO_NOT_REDIRECT
applied_tos AppliedTo List

List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
destinations Destination List

List of the destinations. Null will be treated as any.		 array of ResourceReference Maximum items: 128
destinations_excluded Negation of destination

Negation of the destination.		 boolean Default: "False"
direction Rule direction

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.		 string Enum: IN, OUT, IN_OUT
Default: "IN_OUT"
disabled Rule enable/disable flag

Flag to disable rule. Disabled will only be persisted but never provisioned/realized.		 boolean Default: "False"
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Identifier of the resource string Readonly
ip_protocol IPv4 vs IPv6 packet type

Type of IP packet that should be matched while enforcing the rule.		 string Enum: IPV4, IPV6, IPV4_IPV6
Default: "IPV4_IPV6"
is_default Default rule

Flag to indicate whether rule is default.		 boolean Readonly
logged Enable logging flag

Flag to enable packet logging. Default is disabled.		 boolean Default: "False"
notes Notes

User notes specific to the rule.		 string Maximum length: 2048
resource_type Must be set to the value DSRule string
rule_tag Tag

User level field which will be printed in CLI and packet logs.		 string Maximum length: 32
services Service List

List of the services. Null will be treated as any.		 array of DSService Maximum items: 128
sources Source List

List of sources. Null will be treated as any.		 array of ResourceReference Maximum items: 128
sources_excluded Negation of source

Negation of the source.		 boolean Default: "False"

DSRuleState (schema)

Name Description Type Notes
details Array of configuration state of various sub systems array of ConfigurationStateElement Readonly
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
revision_desired revision number of the desired state integer Readonly
state Overall state of desired configuration

Gives details of state of desired configuration		 string Required
Readonly
Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown

DSSection (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
applied_tos AppliedTo List

List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_default Default section flag

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.		 boolean Readonly
resource_type Must be set to the value DSSection string
rule_count Rule count

Number of rules in this section.		 integer Readonly
section_type Section Type

Type of the rules which a section can contain. Only homogeneous sections are supported.		 string Required
Enum: LAYER2, LAYER3, L3REDIRECT
stateful Stateful nature of the distributed service rules in the section.

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.		 boolean Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DSSectionListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Section list

List of the distributed service sections. The list has to be homogenous.		 array of DSSection Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DSSectionState (schema)

Name Description Type Notes
details Array of configuration state of various sub systems array of ConfigurationStateElement Readonly
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
revision_desired revision number of the desired state integer Readonly
state Overall state of desired configuration

Gives details of state of desired configuration		 string Required
Readonly
Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown

DSService (schema)

Name Description Type Notes
is_valid Target validity

Will be set to false if the referenced NSX resource has been deleted.		 boolean Readonly
service Distributed Service Network and Security Service element

Distributed Service API accepts raw protocol and ports as part of NS service element
in Distributed Service Rule that describes traffic corresponding to an NSService.
NSServiceElement
(Abstract type: pass one of the following concrete types)
ALGTypeNSService
EtherTypeNSService
ICMPTypeNSService
IGMPTypeNSService
IPProtocolNSService
L4PortSetNSService
target_display_name Target display name

Display name of the NSX resource.		 string Readonly
Maximum length: 255
target_id Target ID

Identifier of the NSX resource.		 string Maximum length: 64
target_type Target type

Type of the NSX resource.		 string Maximum length: 255

DailyTelemetrySchedule (schema)

Name Description Type Notes
frequency_type Must be set to the value DailyTelemetrySchedule string Required
hour_of_day Hour at which data will be collected

Hour at which data will be collected. Specify a value between 0 through 23.
integer Required
Minimum: 0
Maximum: 23
minutes Minute at which data will be collected

Minute at which data will be collected. Specify a value between 0 through 59.
integer Minimum: 0
Maximum: 59
Default: "0"

DataSourceParameters (schema)

Name Description Type Notes
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType

DataSourceType (schema)

Data source type.

Name Description Type Notes
DataSourceType Data source type. string Enum: realtime, cached

DataTypeCollectionConfiguration (schema)

Data type collection configuration

Name Description Type Notes
collection_frequency Data Collection Frequency In Seconds

The frequency in seconds at which data is collected		 integer Required
Minimum: 15
Maximum: 86400
data_type Data type

Defines the type of data being collected		 string Required
Enum: STATUS, STATISTICS

Datasource (schema)

Datasource Instance

An instance of a datasource configuration.

Name Description Type Notes
display_name Datasource instance's display name

Name of a datasource instance.		 string Required
Maximum length: 255
urls Array of relative urls and their aliases

Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.		 array of UrlAlias Required

DeploymentConfig (schema)

Name Description Type Notes
placement_type string Required
Enum: VsphereDeploymentConfig

DeploymentSpec (schema)

Deployment spec is a specific version of fabric module

Name Description Type Notes
fabric_module_version version of fabric module string Required
versioned_deployment_specs List of Versioned deployment specs array of VersionedDeploymentSpec Required

DeploymentTemplate (schema)

Service Deployment Template

Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX.

Name Description Type Notes
attributes Deployment Template attributes

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.		 array of Attribute Maximum items: 128
name name

Deployment Template name.		 string

DeploymentTypeListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
deployment_type EdgeDeploymentType
included_fields Comma separated list of fields that should be included in query result string
member_node_type EdgeClusterNodeType
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

DestinationFilteringConfiguration (schema)

Destination filtering configuration

It is used to configure the reputation and category provider. It can also be used to enable or disable the destination filtering feature by setting the enable property.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
customer_id Customer ID

The unique ID assigned to a customer.		 string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enable feature

Flag to enable or disable the feature.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
provider_url Provider URL

URL of the provider which provides the reputation and category databases.		 string Required
resource_type Must be set to the value DestinationFilteringConfiguration string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DhcpFilter (schema)

DHCP filtering configuration

Name Description Type Notes
client_block_enabled Indicates whether DHCP client blocking is enabled boolean Required
server_block_enabled Indicates whether DHCP server blocking is enabled boolean Required

DhcpIpPool (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
allocation_ranges ip-ranges array of IpPoolRange Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
error_threshold error threshold, valid [80-100], default 100 integer Minimum: 80
Maximum: 100
Default: "100"
gateway_ip gateway ip IPAddress
id Unique identifier of this resource string Readonly
Sortable
lease_time lease time, in seconds, [60-(2^32-1)], default 86400 integer Minimum: 60
Maximum: 4294967295
Default: "86400"
options dhcp options

If an option is defined at server level and not configred at
ip-pool/static-binding level, the option will be inherited to
ip-pool/static-binding. If both define a same-code option, the
option defined at ip-pool/static-binding level take precedence
over that defined at server level.
DhcpOptions
resource_type Must be set to the value DhcpIpPool string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
warning_threshold warning threshold, valid [50-80], default 80 integer Minimum: 50
Maximum: 80
Default: "80"

DhcpIpPoolListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of dhcp ip pools array of DhcpIpPool Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DhcpLeaseRequestParameters (schema)

Name Description Type Notes
address can be an ip address, or an ip range, or a mac address string
pool_id The uuid of dhcp ip pool string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType

DhcpOption121 (schema)

Name Description Type Notes
static_routes dhcp classless static routes array of ClasslessStaticRoute Required
Minimum items: 1
Maximum items: 27

DhcpOptions (schema)

Name Description Type Notes
option121 option 121 DhcpOption121
others array of GenericDhcpOption Minimum items: 0
Maximum items: 255

DhcpProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
edge_cluster_id edge cluster uuid string Required
edge_cluster_member_indexes edge node indexes

If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster.
If user provides only one edge node, there will be no HA support.
If both the member indexes are changed in a same PUT API, e.g. change from [a,b] to [x,y],
the current dhcp server states will be lost, which could cause the network crash due to ip conflicts.
Hence the suggestion is to change only one member index in one single update, e.g. from [a,b] to [a,y].
array of integer Minimum items: 0
Maximum items: 2
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value DhcpProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DhcpProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of dhcp profiles array of DhcpProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DhcpRelayProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value DhcpRelayProfile string
server_addresses array of IPAddress Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DhcpRelayProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Dhcp relay profile list results array of DhcpRelayProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DhcpRelayService (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
dhcp_relay_profile_id dhcp relay profile referenced by the dhcp relay service string Required
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value DhcpRelayService string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DhcpRelayServiceListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Dhcp relay service list results array of DhcpRelayService Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DhcpStaticBinding (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
gateway_ip gateway ip IPAddress
host_name host name string
id Unique identifier of this resource string Readonly
Sortable
ip_address ip addres IPAddress Required
lease_time lease time, in seconds, [60-(2^32-1)], default 86400 integer Minimum: 60
Maximum: 4294967295
Default: "86400"
mac_address mac address MACAddress Required
options dhcp options

If an option is defined at server level and not configred at
ip-pool/static-binding level, the option will be inherited to
ip-pool/static-binding. If both define a same-code option, the
option defined at ip-pool/static-binding level take precedence
over that defined at server level.
DhcpOptions
resource_type Must be set to the value DhcpStaticBinding string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DhcpStaticBindingListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of dhcp static bindings array of DhcpStaticBinding Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DirectionType (schema)

port mirroring direction

Name Description Type Notes
DirectionType port mirroring direction string Enum: INGRESS, EGRESS, BIDIRECTIONAL
Default: "BIDIRECTIONAL"

DirectoryAdDomain (schema)

Active Directory Domain

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
base_distinguished_name Directory domain base distinguished name

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.		 string
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
name Directory domain name

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.		 string Required
resource_type Must be set to the value DirectoryAdDomain string Required
sync_settings Directory domain sync settings

Each domain sync settings can be changed using this object. It is not required since there are default values used if there is no specification for this object.		 DirectoryDomainSyncSettings
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DirectoryAdGroup (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
distinguished_name Directory group distinguished name string Required
domain_id Domain id

Domain ID this directory group belongs to.		 string Required
domain_sync_node_id Domain synchronization root node id

Domain sync node under which this directory group is located.		 string Required
id Unique identifier of this resource string Readonly
Sortable
object_guid Active directory group object guid

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.		 string Required
resource_type Must be set to the value DirectoryAdGroup string Required
secure_id Active directory group secure id

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.		 string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DirectoryDomain (schema)

Directory Domain

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
name Directory domain name

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.		 string Required
resource_type Must be set to the value DirectoryDomain string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DirectoryDomainListResults (schema)

List of Directory Domain

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of Directory Domains array of DirectoryDomain
(Abstract type: pass one of the following concrete types)
DirectoryAdDomain
DirectoryDomain		 Required
Maximum items: 500
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DirectoryDomainSyncNode (schema)

Directory Domain Synchronization Nodes

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
distinguished_name Distinguished name

Distinguished name of the domain sync node		 string Required
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value DirectoryDomainSyncNode string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DirectoryDomainSyncNodeListResults (schema)

List of Directory Domain Synchronization Nodes

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of Directory Domain Synchronization Nodes array of DirectoryDomainSyncNode Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DirectoryDomainSyncRemoteNodes (schema)

List of Directory Domain sync remote nodes

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Domain synchronzation node list

Directory domain sync remote node candidate		 array of string Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DirectoryDomainSyncSettings (schema)

Domain synchronization settings

Name Description Type Notes
delta_sync_interval Delta synchronization inverval in minutes

Directory domain delta synchronization interval time between two delta sync in minutes.		 integer Default: "180"
full_sync_cron_expr Full synchronization cron expression

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.		 string
sync_entire_domain Sync entire domain flag

This flag will decide whether to synchronize the directory objects under entire domain or configured synchronization nodes.		 boolean Default: "False"

DirectoryDomainSyncStats (schema)

Directory Domain Synchronization Statistics

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
avg_delta_sync_time Average time spent for all historical delta sync

All the historical delta sync are counted in calculating the average delta sync time in seconds.		 integer Readonly
avg_full_sync_time Average time spent for all historical full sync

All the historical full sync are counted in calculating the average full sync time in seconds.		 integer Readonly
current_state Current state of directory domain sync context

Current running state of the directory domain in synchronization life cycle. It could be one of the following three states.		 string Required
Readonly
Enum: IDLE, FULL_SYNC, DELTA_SYNC
current_state_begin_time Current state elapsed time

Since what time the current state has begun. The time is expressed in millisecond epoch time.		 EpochMsTimestamp Required
Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
num_delta_sync Total number of delta sync

number of historical delta sync initiated either by system or by API request.		 integer Readonly
num_full_sync Total number of full sync

number of historical full sync initiated either by system or by API request.		 integer Readonly
prev_sync_end_time Previous sync ended time

Directory domain previous sync ending time expressed in millisecond epoch time.		 EpochMsTimestamp Required
Readonly
prev_sync_status Previous sync status

Directory domain previous sync status. It could be one of the following two states.		 string Required
Readonly
Enum: SUCCESS, FAILURE, UNKNOWN
prev_sync_type Previous sync type

Directory domain previous sync type. It could be one of the following three states. Right after the directory domain is configured, this field is set to IDLE.		 string Required
Readonly
Enum: IDLE, FULL_SYNC, DELTA_SYNC
resource_type Must be set to the value DirectoryDomainSyncStats string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DirectoryGroup (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
distinguished_name Directory group distinguished name string Required
domain_id Domain id

Domain ID this directory group belongs to.		 string Required
domain_sync_node_id Domain synchronization root node id

Domain sync node under which this directory group is located.		 string Required
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value DirectoryGroup string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DirectoryGroupListResults (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Directory group list array of DirectoryGroup
(Abstract type: pass one of the following concrete types)
DirectoryAdGroup
DirectoryGroup		 Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DirectoryGroupMember (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
group_distinguished_name Group distinguished name

Directory group distinguished name this group member belongs to.		 string Required
group_id Group idnetifier

Directory group id this group member belongs to		 string Required
id Unique identifier of this resource string Readonly
Sortable
member_group_distinguished_name Member group distinguished name

Directory group name this group member owns		 string Required
member_group_id Member group idnetifier

Directory group id this group member owns		 string Required
nested Nesting flag

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.		 boolean Required
resource_type Must be set to the value DirectoryGroupMember string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DirectoryGroupMemberListResults (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Directory group member list array of DirectoryGroupMember Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DirectoryLdapServer (schema)

Ldap Server of Directory Domain

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Ldap server enable flag

Whether this directory LDAP server is enabled or not.		 boolean Default: "True"
host Ldap server host name

Directory LDAP server DNS host name or ip address which is reachable by NSX manager to be connected and do object synchronization.		 string Required
id Unique identifier of this resource string Readonly
Sortable
password Ldap server password

Directory LDAP server connection password.		 string Required
port Ldap server TCP/UDP port

Directory LDAP server connection TCP/UDP port.		 integer Default: "389"
protocol Ldap server protocol

Directory LDAP server connection protocol which is either LDAP or LDAPS.		 string Enum: LDAP, LDAPS
Default: "LDAP"
resource_type Must be set to the value DirectoryLdapServer string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
thumbprint Ldap server certificate thumbprint using SHA-256 algorithm

Directory LDAP server certificate thumbprint used in secure LDAPS connection.		 string
username Ldap server username

Directory LDAP server connection user name.		 string Required

DirectoryLdapServerListResults (schema)

List of Directory Domain LDAP servers

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of Directory Domain Ldap Servers array of DirectoryLdapServer Required
Maximum items: 50
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DirectorySearchPattern (schema)

Searching domain entities using a matching pattern

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
pattern Name search pattern

Search pattern is a substring match pattern only which the target entity contains		 string Required
sort_ascending boolean
sort_by Field by which records are sorted string

DiscoveredNode (schema)

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
certificate Certificate of the discovered node string
cm_local_id Local Id of the discovered node in the Compute Manager string Required
Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Display name of discovered node string Required
Readonly
external_id External id of the discovered node, ex. a mo-ref from VC string Required
Readonly
hardware_id Hardware Id of the discovered node

Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx.		 string Readonly
ip_addresses IP Addresses of the the discovered node. array of IPAddress Required
Readonly
node_type Discovered Node type like Host string Required
Readonly
origin_id Id of the compute manager from where this node was discovered string Required
Readonly
origin_properties Key-Value map of additional specific properties of discovered node in the Compute Manager array of KeyValuePair Readonly
os_type OS type of the discovered node string Readonly
os_version OS version of the discovered node string Readonly
parent_compute_collection External id of the compute collection to which this node belongs string Readonly
resource_type Must be set to the value DiscoveredNode string
stateless Specifies whether host is stateless

The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true.		 boolean Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DiscoveredNodeInterfaceProperties (schema)

Discovered node network interface properties

Network interface properties of discovered node

Name Description Type Notes
connected_switch Connected switch

Switch name which is connected to nic, switch can be opaque, proxyHostSwitch or virtual		 string
interface_id Interface ID

Id of the network interface		 string
physical_address Interface MAC address

Mac address of the interface		 MACAddress

DiscoveredNodeListRequestParameters (schema)

Discovered Node list parameters

Name Description Type Notes
cm_local_id Local Id of the discovered node in the Compute Manager string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
display_name Display name of discovered node string
external_id External id of the discovered node, ex. a mo-ref from VC string
has_parent Discovered node has a parent compute collection or is a standalone host string Enum: true, false
included_fields Comma separated list of fields that should be included in query result string
ip_address IP address of the discovered node string
node_id Id of the fabric node created from the discovered node string
node_type Discovered Node type like HostNode string
origin_id Id of the compute manager from where this node was discovered string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
parent_compute_collection External id of the compute collection to which this node belongs string
sort_ascending boolean
sort_by Field by which records are sorted string

DiscoveredNodeListResult (schema)

Discovered Node list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Discovered Node list results array of DiscoveredNode Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DiscoveredNodeNetworkInterfaces (schema)

Discovered node network interfaces

All the network interfaces of the discovered node

Name Description Type Notes
discovered_node_id Discovered node Id

Id of the discovered node		 string Required
network_interfaces Discovered Node interfaces

Network interfaces of the node		 array of DiscoveredNodeInterfaceProperties

DiscoveredResource (schema)

Base class for resources that are discovered and automatically updated

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
resource_type The type of this resource. string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DnsForwarder (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
cache_size Cache size in KB

One dns answer cache entry will consume ~120 bytes. Hence 1 KB cache
size can cache ~8 dns answer entries, and the default 1024 KB cache
size can hold ~8k dns answer entries.
int Minimum: 1
Maximum: 16777216
Default: "1024"
conditional_forwarders Conditional zone forwarders

The conditional zone forwarders. During matching a zone forwarder,
the dns forwarder will use the conditional fowarder with the longest
domain name that matches the query.
array of ConditionalForwarderZone Maximum items: 5
default_forwarder Default zone forwarder

The default zone forwarder that catches all other domain names except
those matched by conditional forwarder zone.
ForwarderZone Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
listener_ip Listener ip address

The ip address the dns forwarder listens on. It can be an ip address
already owned by the logical-router uplink port or router-link, or a
loopback port ip address. But it can not be a downlink port address.
User needs to ensure the address is reachable via router or NAT from
both client VMs and upstream servers. User will need to create Firewall
rules if needed to allow such traffic on a Tier-1 or Tier-0.
IPv4Address Required
log_level Log level of the dns forwarder string Enum: DEBUG, INFO, WARNING, ERROR, FATAL
Default: "INFO"
logical_router_id Logical router id

Specify the LogicalRouter where the DnsForwarder runs. The HA mode
of the hosting LogicalRouter must be Active/Standby.
string Required
resource_type Must be set to the value DnsForwarder string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

DnsForwarderListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paginated list of dns forwarders array of DnsForwarder Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

DnsSettings (schema)

DNS settings

Stores Azure gateway DNS settings like dns_mode and dns_list.

Name Description Type Notes
dns_list List of nameserver(s)

The is a list of nameserver ipv4 addresses that will be used by the
public cloud gateway. DNS will use these nameserver(s) if the
cloud_dns_mode is set to PRECONFIGURED.
array of string
dns_mode DNS mode

DHCP: Obtain nameserver(s) from DHCP.
PRECONFIGURED: User supplies list of nameserver(s).
CLOUD: Use cloud provider DNS.
string Enum: DHCP, PRECONFIGURED, CLOUD
Default: "DHCP"

DonutConfiguration (schema)

Donut Configuration

Represents configuration of a Donut

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
datasources Array of Datasource Instances with their relative urls

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.		 array of Datasource Minimum items: 0
description Description of this resource string Maximum length: 1024
Sortable
display_count Show or hide the count of entities

If true, displays the count of entities in the donut		 boolean Default: "True"
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
drilldown_id Id of drilldown widget

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.		 string Maximum length: 255
footer Footer
id Unique identifier of this resource string Readonly
Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.		 boolean Default: "False"
label Label of the Donut Configuration

Displayed at the middle of the donut, by default. It labels the entities of donut.		 Label
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details.		 string Maximum length: 1024
resource_type Must be set to the value DonutConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration
Maximum length: 255
sections Sections array of DonutSection Required
Minimum items: 1
shared Visiblity of widgets to other users

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.		 boolean Deprecated
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.		 int Deprecated

DonutPart (schema)

Portion of a donut or stats chart

Represents an entity or portion to be plotted on a donut or stats chart.

Name Description Type Notes
field Value of the portion or entity of donut or stats chart

A numerical value that represents the portion or entity of the donut or stats chart.		 string Required
Maximum length: 1024
label Label of the portion or entity of donut or stats chart

If a section 'template' holds this donut or stats part, then the label is auto-generated from the fetched field values after applying the template.		 Label
render_configuration Render Configuration

Additional rendering or conditional evaluation of the field values to be performed, if any.		 array of RenderConfiguration Minimum items: 0
tooltip Multi-line tooltip

Multi-line text to be shown on tooltip while hovering over the portion.		 array of Tooltip Minimum items: 0

DonutSection (schema)

Section of a donut or stats chart

Represents high level logical grouping of portions or segments of a donut / stats chart.

Name Description Type Notes
parts Parts of a donut / stats chart

Array of portions or parts of the donut or stats chart.		 array of DonutPart Required
Minimum items: 1
row_list_field Field from which parts of the donut or stats chart are formed

Field of the root of the api result set for forming parts.		 string Maximum length: 1024
template Template, if any, for automatically forming the donut or stats parts

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'.		 boolean Default: "False"

Dscp (schema)

One of Quality-of-Service or Encapsulated-Remote-Switched-Port-Analyzer

Dscp value is ignored in case of 'TRUSTED' DscpMode.

Name Description Type Notes
mode DscpMode
priority Internal Forwarding Priority int Minimum: 0
Maximum: 63
Default: "0"

DscpMode (schema)

Trust settings

Name Description Type Notes
DscpMode Trust settings string Enum: TRUSTED, UNTRUSTED
Default: "TRUSTED"

EULAAcceptance (schema)

Indicate the status of End User License Agreement acceptance

Name Description Type Notes
acceptance End User License Agreement acceptance status boolean Required

EULAContent (schema)

End User License Agreement content

Name Description Type Notes
content End User License Agreement content string Required

EULAOutputFormatRequestParameters (schema)

Indicate output format of End User License Agreement content

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
format End User License Agreement content output format string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

EdgeCluster (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
cluster_profile_bindings Edge cluster profile bindings array of ClusterProfileTypeIdEntry
deployment_type Edge cluster deployment type

This field is a readonly field which shows the deployment_type of members.
It returns UNKNOWN if there are no members, and returns VIRTUAL_MACHINE|
PHYSICAL_MACHINE if all edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
It returns HYBRID if the cluster contains edge members of both types
VIRTUAL_MACHINE and PHYSICAL_MACHINE.
EdgeDeploymentType Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
member_node_type Node type of the cluster members

Edge cluster is homogenous collection of transport nodes.
Hence all transport nodes of the cluster must be of same type.
This readonly field shows the type of transport nodes.
EdgeClusterNodeType Readonly
members Edge cluster members

EdgeCluster only supports homogeneous members.
These member should be backed by either EdgeNode or PublicCloudGatewayNode.
TransportNode type of these nodes should be the same.
DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is
recommended to be the same. EdgeCluster supports members of different
deployment types.
array of EdgeClusterMember
resource_type Must be set to the value EdgeCluster string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

EdgeClusterListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Edge cluster list results array of EdgeCluster Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

EdgeClusterMember (schema)

Name Description Type Notes
description description of edge cluster member

description of edge cluster member		 string
display_name display name of edge cluster member

display name of edge cluster member		 string
member_index System generated index for cluster member

System generated index for cluster member		 int Readonly
transport_node_id UUID of edge transport node

Identifier of the transport node backed by an Edge node		 string Required

EdgeClusterMemberAllocationPool (schema)

This is an abstract type. Concrete child types:
LoadBalancerAllocationPool

Name Description Type Notes
allocation_pool_type AllocationPoolType Required

EdgeClusterMemberAllocationProfile (schema)

Name Description Type Notes
allocation_pool Edge Cluster Member Allocation Pool for logical router

Logical router allocation can be tracked for specific services and
services may have their own hard limits and allocation sizes. For
example load balancer pool should be specified if load balancer
service will be attached to logical router.
EdgeClusterMemberAllocationPool
(Abstract type: pass one of the following concrete types)
LoadBalancerAllocationPool

EdgeClusterMemberListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results edge cluster member list results array of EdgeClusterMember Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

EdgeClusterNodeType (schema)

Supported edge cluster node type.

Name Description Type Notes
EdgeClusterNodeType Supported edge cluster node type. string Enum: EDGE_NODE, PUBLIC_CLOUD_GATEWAY_NODE, UNKNOWN

EdgeDeploymentType (schema)

Supported edge deployment type.

Name Description Type Notes
EdgeDeploymentType Supported edge deployment type. string Enum: VIRTUAL_MACHINE, PHYSICAL_MACHINE, UNKNOWN

EdgeFormFactor (schema)

Supported edge form factor.

Name Description Type Notes
EdgeFormFactor Supported edge form factor. string Enum: SMALL, MEDIUM, LARGE

EdgeHighAvailabilityProfile (schema)

Profile for BFD HA cluster setting

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
bfd_allowed_hops BFD allowed hops integer Minimum: 1
Maximum: 255
Default: "255"
bfd_declare_dead_multiple Number of times a packet is missed before BFD declares the neighbor down. integer Minimum: 2
Maximum: 16
Default: "3"
bfd_probe_interval the time interval (in millisec) between probe packets for heartbeat purpose integer Minimum: 300
Maximum: 60000
Default: "1000"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value EdgeHighAvailabilityProfile ClusterProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

EdgeNode (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
allocation_list Allocation list

List of logical router ids to which this edge node is allocated.		 array of string Readonly
deployment_config Config for automatic deployment of edge node virtual machine.

When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE
will be deployed and registered with MP.
EdgeNodeDeploymentConfig
deployment_type EdgeDeploymentType Readonly
description Description of this resource string Maximum length: 1024
Sortable
discovered_ip_addresses Discovered IP Addresses of the fabric node, version 4 or 6 array of IPAddress Readonly
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id ID of the Node maintained on the Node and used to recognize the Node string
fqdn Fully qualified domain name of the fabric node string Readonly
id Unique identifier of this resource string Readonly
Sortable
ip_addresses IP Addresses of the Node, version 4 or 6

IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for
automatic deployment of edge virtual machine node. For automatic deployment, the ip address from
management_port_subnets property will be considered.
array of IPAddress
resource_type Must be set to the value EdgeNode string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

EdgeNodeDeploymentConfig (schema)

Name Description Type Notes
form_factor EdgeFormFactor Default: "MEDIUM"
node_user_settings Node user settings

Username and password settings for the node.
Note - these settings will be honored only during node deployment.
Post deployment, CLI must be used for changing the user settings, changes to these parameters will not have any effect.
NodeUserSettings Required
vm_deployment_config DeploymentConfig
(Abstract type: pass one of the following concrete types)
DeploymentConfig
VsphereDeploymentConfig		 Required

EdgeUpgradeStatus (schema)

Status of edge upgrade

Name Description Type Notes
can_skip Can the upgrade of the remaining units in this component be skipped boolean Readonly
component_type Component type for the upgrade status string Readonly
details Details about the upgrade status string Readonly
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
status Upgrade status of component string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

EffectiveIPAddressMemberListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged Collection of effective ip addresses for the given NSGroup array of IPElement Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

EffectiveMemberResourceListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged Collection of resources which are the effective members of an NSGroup. array of ResourceReference Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

EgressRateShaper (schema)

A shaper that specifies egress rate properties in Mb/s

Name Description Type Notes
average_bandwidth_mbps Average bandwidth in Mb/s int Minimum: 0
Default: "0"
burst_size_bytes Burst size in bytes int Minimum: 0
Default: "0"
enabled boolean Required
peak_bandwidth_mbps Peak bandwidth in Mb/s int Minimum: 0
Default: "0"
resource_type Must be set to the value EgressRateShaper string Enum: IngressRateShaper, IngressBroadcastRateShaper, EgressRateShaper
Default: "IngressRateShaper"

EmbeddedResource (schema)

Base class for resources that are embedded in other resources

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_owner Owner of this resource OwnerResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Identifier of the resource string Readonly
resource_type The type of this resource. string

EncapsulationType (schema)

Encapsulation type for L3PortMirrorSession

You can choose the encapsulation type of the mirroring, now we support
GRE, ERSPAN II and ERSPAN III.

Name Description Type Notes
EncapsulationType Encapsulation type for L3PortMirrorSession

You can choose the encapsulation type of the mirroring, now we support
GRE, ERSPAN II and ERSPAN III.
string Enum: GRE, ERSPAN_TWO, ERSPAN_THREE

Endpoint (schema)

Tunnel endpoint configuration

An Endpoint object is part of HostSwitch configuration in TransportNode

Name Description Type Notes
default_gateway Gateway IP IPAddress Readonly
device_name Name of the virtual tunnel endpoint string Readonly
ip IP Address of this virtual tunnel endpoint

Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool.		 IPAddress Readonly
label Unique label for this Endpoint int Readonly
mac MAC address MACAddress Readonly
subnet_mask Subnet mask IPAddress Readonly

EpochMsTimestamp (schema)

Timestamp in milliseconds since epoch

Name Description Type Notes
EpochMsTimestamp Timestamp in milliseconds since epoch integer

ErrorResolverInfo (schema)

Metadata related to a given error_id

Name Description Type Notes
error_id The error id for which metadata information is needed integer Required
resolver_present Indicates whether there is a resolver associated with the error or not boolean Required
user_metadata User supplied metadata that might be required by the resolver ErrorResolverUserMetadata

ErrorResolverInfoList (schema)

Collection of all registered ErrorResolverInfo

Name Description Type Notes
results ErrorResolverInfo list array of ErrorResolverInfo Required

ErrorResolverMetadata (schema)

Error along with its metadata

Name Description Type Notes
entity_id The entity/node UUID where the error has occurred. string Required
error_id The error id as reported by the entity where the error occurred. integer Required
system_metadata This can come from some external system like syslog collector ErrorResolverSystemMetadata
user_metadata User supplied metadata that might be required by the resolver ErrorResolverUserMetadata

ErrorResolverMetadataList (schema)

List of errors with their metadata

Name Description Type Notes
errors List of errors with their corresponding metadata. array of ErrorResolverMetadata Required

ErrorResolverSystemMetadata (schema)

Metadata fetched from an external system like Syslog or LogInsight.

Name Description Type Notes
value The value fetched from another system string

ErrorResolverUserInputData (schema)

Corresponds to one property entered by the user

Name Description Type Notes
data_type The datatype of the given property. Useful for data validation string Required
Enum: TEXT, NUMBER, PASSWORD
property_name Name of the property supplied by the user string Required
property_value The value associated with the above property string

ErrorResolverUserMetadata (schema)

User supplied metadata needed for resolving errors

Name Description Type Notes
user_input_list List of user supplied input data. array of ErrorResolverUserInputData

EtherTypeNSService (schema)

An NSService element that represents an ethertype protocol

Name Description Type Notes
ether_type Type of the encapsulated protocol integer Required
resource_type Must be set to the value EtherTypeNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

ExcludeList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
members ExcludeList member list

List of the members in the exclude list		 array of ResourceReference Required
Maximum items: 100
resource_type Must be set to the value ExcludeList string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ExtraConfig (schema)

Vendor specific configuration on logical switch or logical port

Extra config is intended for supporting vendor specific configuration on the
data path, it can be set as key value string pairs on either logical switch
or logical port.
If it was set on logical switch, it will be inherited automatically by logical
ports in it. Also logical port setting will override logical switch setting
if specific key was dual set on both logical switch and logical port.

Name Description Type Notes
config_pair Key value pair in string for the configuration KeyValuePair Required

ExtraConfigHostSwitchProfile (schema)

Profile for extra configs in host switch

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
extra_configs list of extra configs array of ExtraConfig
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value ExtraConfigHostSwitchProfile HostSwitchProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

FabricModule (schema)

Fabric Module contains list of deployment specs and current version.

Fabric module contains list of deployment specs and current version.
Each deployment spec is a different version of same fabric module.
If fabric module have two deployment specs or say two different versions then
current version will specify which version needs to be installed.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
current_version current version on for the host prep fabric module. string Required
custom_data Customer data

Slot for storing consumer data (fabric module's specific
data common across all the realizations of the fabric
module)
array of StringMapEntry
deployment_specs List of deployment specs array of DeploymentSpec Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fabric_module_name Name of the fabric module string Required
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value FabricModule string
source_authentication_mode Authentication needed by fabric module at source

This enum specifies the authentication supported
at source i.e. for downloading VM.
If this attribute is not provided, then NO_AUTHENTICATION
will be considered.
string Enum: NO_AUTHENTICATION, BASIC_AUTHENTICATION, MARKET_PLACE
Default: "NO_AUTHENTICATION"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

FabricModuleListRequestParameters (schema)

Request parameters for read host fabric module.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
fabric_module_name name of fabric module. string Enum: hostprep
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

FabricModuleListResult (schema)

Fabric Module list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Fabric Module list results array of FabricModule Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FailedNodeSupportBundleResult (schema)

Name Description Type Notes
error_code Error code string Required
Readonly
error_message Error message string Required
Readonly
node_display_name Display name of node string Required
Readonly
node_id UUID of node string Required
Readonly

FeatureAccess (schema)

Feature access

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Feature enabled or not boolean Required
Readonly
feature Feature string Readonly
id Unique identifier of this resource string Readonly
Sortable
information Feature Info array of FeatureInfo
resource_type Must be set to the value FeatureAccess string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

FeatureAccessListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List results array of FeatureAccess Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FeatureInfo (schema)

Feature Info

Name Description Type Notes
info Info string Required
Readonly

FeaturePermission (schema)

Feature Permission

Name Description Type Notes
feature Feature Name string Required
Readonly
permission Permission string Required
Readonly
Enum: crud, read, execute, none

FeaturePermissionListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List results array of FeaturePermission Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FeatureStackCollectionConfiguration (schema)

HPM feature stack data collection frequency configuration

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
client_type_collection_configurations Client type collection configurations

The set of client type data collection configurations		 array of ClientTypeCollectionConfiguration
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
feature_stack_name Feature stack name

The name of the feature stack		 string Required
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value FeatureStackCollectionConfiguration string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

FeatureStackCollectionConfigurationList (schema)

Feature stack collection configuration list result

Name Description Type Notes
results Feature stack configurations

The complete set of feature stack data collection configurations		 array of FeatureStackCollectionConfiguration Readonly

FeatureUsage (schema)

feature usage result item

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
capacity_usage Capacity Usage List array of CapacityUsage Required
Readonly
feature name of the feature string Readonly

FeatureUsageCsvRecord (schema)

Name Description Type Notes
cpu_usage_count count of number of cpu sockets used by this feature integer Readonly
feature name of the feature string Readonly
vcpu_usage_count count of number of vcpus of public cloud VMs integer Readonly
vm_usage_count count of number of vms used by this feature integer Readonly

FeatureUsageList (schema)

list of feature usage items

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
feature_usage_info Feature Usage List array of FeatureUsage Required
Readonly

FeatureUsageListInCsvFormat (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
last_update_timestamp Timestamp when the data was last updated; unset if data source has
never updated the data.
EpochMsTimestamp Readonly
results array of FeatureUsageCsvRecord

FileHash (schema)

File hash code

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
hash_code Computed hash of file string Required
hash_type Algorithm used to compute the file's hash string Required
Enum: SHA1
name File name string Required
Pattern: "^[^/]+$"

FileProperties (schema)

File properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
created_epoch_ms File creation time in epoch milliseconds integer Required
modified_epoch_ms File modification time in epoch milliseconds integer Required
name File name string Required
Pattern: "^[^/]+$"
size Size of the file in bytes integer Required

FilePropertiesListResult (schema)

File properties query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results File property results array of FileProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FileThumbprint (schema)

File thumbprint

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
name File name string Required
Pattern: "^[^/]+$"
sha1 File's SHA1 thumbprint string Required
sha256 File's SHA256 thumbprint string Required

FileTransferAuthenticationScheme (schema)

Remote server authentication details

Name Description Type Notes
password Password to authenticate with string
scheme_name Authentication scheme name string Required
Enum: PASSWORD
username User name to authenticate with string Required
Pattern: "^([a-zA-Z][a-zA-Z0-9-.]*[a-zA-Z]\\\){0,1}\w[\w.-]+$"

FileTransferProtocol (schema)

Protocol to transfer backup file to remote server

Name Description Type Notes
authentication_scheme Scheme to authenticate if required FileTransferAuthenticationScheme Required
protocol_name Protocol name string Required
Enum: sftp
Default: "sftp"
ssh_fingerprint SSH fingerprint of server

The expected SSH fingerprint of the server. If the server's fingerprint
does not match this fingerprint, the connection will be terminated.

Only ECDSA fingerprints hashed with SHA256 are supported. To obtain the
host's ssh fingerprint, you should connect via some method other than
SSH to obtain this information. You can use one of these commands to
view the key's fingerprint:
1. ssh-keygen -l -E sha256 -f ssh_host_ecdsa_key.pub
2. awk '{print $2}' ssh_host_ecdsa_key.pub | base64 -d | sha256sum -b |
sed 's/ .*$//' | xxd -r -p | base64 | sed 's/.//44g' |
awk '{print "SHA256:"$1}'
string Required
Pattern: "^SHA256:.*$"

FileUsageListParameters (schema)

File Usage list parameters

Name Description Type Notes
appliance_type Type of appliance string Enum: MP, CCP, EDGE
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

FilterRequest (schema)

Filter request

Filter request parameters

Name Description Type Notes
field_names Field Names

Comma seperated fields to be filtered on		 string Required
value Value

Filter value		 string Required

FireWallServiceAssociationListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Firewall rule list result

Firewall rule list result with pagination support.		 array of FirewallRule Required
Readonly
service_type Must be set to the value FireWallServiceAssociationListResult string Required
Enum: FireWallServiceAssociationListResult, IpfixServiceAssociationListResult
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FirewallCategory (schema)

Firewall Category

Statistic category for the type of rules in a section, like Layer2 Distributed Firewall, Layer3 DFW.

Name Description Type Notes
FirewallCategory Firewall Category

Statistic category for the type of rules in a section, like Layer2 Distributed Firewall, Layer3 DFW.		 string Readonly
Enum: L2DFW, L3DFW

FirewallContextType (schema)

Firewall Context Type

Types of firewall contexts.

Name Description Type Notes
FirewallContextType Firewall Context Type

Types of firewall contexts.		 string Enum: transport_nodes, logical_routers

FirewallListRequestParameters (schema)

Parameters to filter list of sections/rules.

Pagination and Filtering parameters to get only a subset of sections/rules.

Name Description Type Notes
applied_tos AppliedTo's referenced by this section or section's Distributed Service Rules .

Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
destinations Destinations referenced by this section's Distributed Service Rules .

The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
filter_type Filter type

Filter type defines matching criteria to qualify a rule in result. Type
'FILTER' will ensure all criterias (sources, destinations, services,
appliedtos) are matched. Type 'SEARCH' will match any of the given
criteria.
string Enum: FILTER, SEARCH
Default: "FILTER"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
search_invalid_references Return invalid references in results.

Used in conjunction with filter_type to find invalid i.e. non nonexistent references in given criteria (sources, destinations, services, applied_tos).		 boolean Default: "False"
services NSService referenced by this section's Distributed Service Rules .

Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
sort_ascending boolean
sort_by Field by which records are sorted string
sources Sources referenced by this section's Distributed Service Rules .

The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string

FirewallRule (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_owner Owner of this resource OwnerResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
action Action

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).		 string Required
Enum: ALLOW, DROP, REJECT, REDIRECT, DO_NOT_REDIRECT
applied_tos AppliedTo List

List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
destinations Destination List

List of the destinations. Null will be treated as any.		 array of ResourceReference Maximum items: 128
destinations_excluded Negation of destination

Negation of the destination.		 boolean Default: "False"
direction Rule direction

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.		 string Enum: IN, OUT, IN_OUT
Default: "IN_OUT"
disabled Rule enable/disable flag

Flag to disable rule. Disabled will only be persisted but never provisioned/realized.		 boolean Default: "False"
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Identifier of the resource string Readonly
ip_protocol IPv4 vs IPv6 packet type

Type of IP packet that should be matched while enforcing the rule.		 string Enum: IPV4, IPV6, IPV4_IPV6
Default: "IPV4_IPV6"
is_default Default rule

Flag to indicate whether rule is default.		 boolean Readonly
logged Enable logging flag

Flag to enable packet logging. Default is disabled.		 boolean Default: "False"
notes Notes

User notes specific to the rule.		 string Maximum length: 2048
resource_type Must be set to the value FirewallRule string
rule_tag Tag

User level field which will be printed in CLI and packet logs.		 string Maximum length: 32
section_id Section Id

Section Id of the section to which this rule belongs to.		 string Readonly
services Service List

List of the services. Null will be treated as any.		 array of FirewallService Maximum items: 128
sources Source List

List of sources. Null will be treated as any.		 array of ResourceReference Maximum items: 128
sources_excluded Negation of source

Negation of the source.		 boolean Default: "False"

FirewallRuleListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Firewall rule list result

Firewall rule list result with pagination support.		 array of FirewallRule Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FirewallSection (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
applied_tos AppliedTo List

List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.		 array of ResourceReference Maximum items: 128
autoplumbed Tells if a section is auto-plumbed or not

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.		 boolean Readonly
Default: "False"
comments Section lock/unlock comments

Comments for section lock/unlock.		 string Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enforced_on Firewall Section Enforcement type

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.		 string Readonly
id Unique identifier of this resource string Readonly
Sortable
is_default Default section flag

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.		 boolean Readonly
lock_modified_by Lock modified by user

ID of the user who last modified the lock for the section.		 string Readonly
lock_modified_time Section locked/unlocked time

Section locked/unlocked time in epoch milliseconds.		 EpochMsTimestamp Readonly
locked Section Locked

Section is locked/unlocked.		 boolean Readonly
Default: "False"
resource_type Must be set to the value FirewallSection string
rule_count Rule count

Number of rules in this section.		 integer Readonly
section_type Section Type

Type of the rules which a section can contain. Only homogeneous sections are supported.		 string Required
Enum: LAYER2, LAYER3, L3REDIRECT
stateful Stateful nature of the distributed service rules in the section.

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.		 boolean Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

FirewallSectionFilterParameters (schema)

Parameters to filter section from list of sections

Pagination and Filtering parameters to get only a subset of sections.

Name Description Type Notes
applied_tos AppliedTo's referenced by this section or section's Distributed Service Rules .

Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
destinations Destinations referenced by this section's Distributed Service Rules .

The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
enforced_on Limit result to sections having a specific kind of enforcement point

Used to filter out results based on enforcement point of the section. If this parameter is BRIDGEENDPOINT, then return firewall sections enfored on logical port with attachment type bridgeendpoint. For LOGICALROUTER, then firewall sections enforced on Logical Router are returned. For VIF, other firewall sections are returned. Other values are not supported.		 AttachmentTypeQueryString
exclude_applied_to_type Limit result to sections not having a specific AppliedTo type

Used to filter out sections not having a specified AppliedTo target type. This parameter cannot be used along with include_applied_to_type parameter. Section filter only takes a single value for this param.		 DSAppliedToType
filter_type Filter type

Filter type defines matching criteria to qualify a rule in result. Type
'FILTER' will ensure all criterias (sources, destinations, services,
appliedtos) are matched. Type 'SEARCH' will match any of the given
criteria.
string Enum: FILTER, SEARCH
Default: "FILTER"
include_applied_to_type Limit result to sections having a specific AppliedTo type

Used to filter out results based on target type of a section's AppliedTo. Only sections with matching target type in its applied to will be returned. This parameter cannot be used along with exclude_applied_to_type parameter.Section filter only takes a single value for this param.		 DSAppliedToType
included_fields Comma separated list of fields that should be included in query result string
locked Limit results to sections which are locked/unlocked

Used to filter out locked or unlocked sections.		 boolean
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
search_invalid_references Return invalid references in results.

Used in conjunction with filter_type to find invalid i.e. non nonexistent references in given criteria (sources, destinations, services, applied_tos).		 boolean Default: "False"
search_scope Limit result to sections of a specific enforcement point

This parameter can be used to limit the search scope to certain firewalls. It can be the value of an appliedTo of a bridge port firewall or an edge firewal. Results will include sections only from that bridge port firewall or edge firewall. For example, if the identifier of a bridge port is given, the search result will only contain the sections of that bridge port firewall. If the identifier of logical router is given, the search result will only contain the sections of that edge firewall.		 string
services NSService referenced by this section's Distributed Service Rules .

Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
sort_ascending boolean
sort_by Field by which records are sorted string
sources Sources referenced by this section's Distributed Service Rules .

The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
type Section Type

Section Type with values layer2 or layer3		 string Enum: LAYER2, LAYER3
Default: "LAYER3"

FirewallSectionListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Section list

List of the firewall sections. The list has to be homogenous.		 array of FirewallSection Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FirewallSectionRuleList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
applied_tos AppliedTo List

List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.		 array of ResourceReference Maximum items: 128
autoplumbed Tells if a section is auto-plumbed or not

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.		 boolean Readonly
Default: "False"
comments Section lock/unlock comments

Comments for section lock/unlock.		 string Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enforced_on Firewall Section Enforcement type

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.		 string Readonly
id Unique identifier of this resource string Readonly
Sortable
is_default Default section flag

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.		 boolean Readonly
lock_modified_by Lock modified by user

ID of the user who last modified the lock for the section.		 string Readonly
lock_modified_time Section locked/unlocked time

Section locked/unlocked time in epoch milliseconds.		 EpochMsTimestamp Readonly
locked Section Locked

Section is locked/unlocked.		 boolean Readonly
Default: "False"
resource_type Must be set to the value FirewallSectionRuleList string
rule_count Rule count

Number of rules in this section.		 integer Readonly
rules List of the firewall rules

List of firewall rules in the section. Only homogenous rules are supported.		 array of FirewallRule Required
Maximum items: 1000
section_type Section Type

Type of the rules which a section can contain. Only homogeneous sections are supported.		 string Required
Enum: LAYER2, LAYER3, L3REDIRECT
stateful Stateful nature of the distributed service rules in the section.

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.		 boolean Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

FirewallSectionState (schema)

Name Description Type Notes
details Array of configuration state of various sub systems array of ConfigurationStateElement Readonly
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
revision_desired revision number of the desired state integer Readonly
state Overall state of desired configuration

Gives details of state of desired configuration		 string Required
Readonly
Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown

FirewallSectionsSummary (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
rule_count Rule count

Total number of rules in the section.		 integer Readonly
section_count Section count

Total number of sections for the section type.		 integer Readonly
section_type Section Type

Type of rules which a section can contain.		 FirewallCategory Readonly

FirewallService (schema)

Name Description Type Notes
is_valid Target validity

Will be set to false if the referenced NSX resource has been deleted.		 boolean Readonly
service Distributed Service Network and Security Service element

Distributed Service API accepts raw protocol and ports as part of NS service element
in Distributed Service Rule that describes traffic corresponding to an NSService.
NSServiceElement
(Abstract type: pass one of the following concrete types)
ALGTypeNSService
EtherTypeNSService
ICMPTypeNSService
IGMPTypeNSService
IPProtocolNSService
L4PortSetNSService
target_display_name Target display name

Display name of the NSX resource.		 string Readonly
Maximum length: 255
target_id Target ID

Identifier of the NSX resource.		 string Maximum length: 64
target_type Target type

Type of the NSX resource.		 string Maximum length: 255

FirewallStats (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
byte_count bytes count

Aggregated number of bytes processed by the rule.		 integer Readonly
max_popularity_index The maximum popularity index

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.		 integer Readonly
max_session_count Maximum Sessions count

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.		 integer Readonly
packet_count packets count

Aggregated number of packets processed by the rule.		 integer Readonly
popularity_index The index of the popularity of firewall rule

This is calculated by sessions count divided by age of the rule.		 integer Readonly
rule_id Firewall rule Id

Rule Identifier of the Firewall rule. This is a globally unique number.		 string Readonly
session_count sessions count

Aggregated number of sessions processed by the rule.		 integer Readonly
total_session_count Total Sessions count

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.		 integer Readonly

FirewallStatus (schema)

Firewall Status Response

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
context Firewall Context Type

Types of firewall contexts.		 FirewallContextType Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
global_status Firewall Status Type

Firewall status for a fabric entity or in global context where firewall is supported.		 FirewallStatusType Required
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value FirewallStatus string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
target_statuses List of target resource status

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).		 array of TargetResourceStatus

FirewallStatusListResult (schema)

Firewall Statuses

List of firewall statuses for a context or all context

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results array of FirewallStatus Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

FirewallStatusType (schema)

Firewall Status Type

Types of firewall statuses representing state of DFW for a context type (e.g. transport_nodes).

Name Description Type Notes
FirewallStatusType Firewall Status Type

Types of firewall statuses representing state of DFW for a context type (e.g. transport_nodes).		 string Enum: DISABLED, ENABLED

Footer (schema)

Widget Footer

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.

Name Description Type Notes
actions Footer Actions

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.		 array of FooterAction Minimum items: 0
condition Expression for evaluating condition

If the condition is met then the footer will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.		 string Maximum length: 1024

FooterAction (schema)

Widget Footer Action

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.

Name Description Type Notes
dock_to_container_footer Dock the footer at container

If true, the footer will appear in the underlying container that holds the widget.		 boolean Default: "True"
label Label for action

Label to be displayed against the footer action.		 Label Required
url Clickable hyperlink, if any

Hyperlink to the UI page that provides details of action.		 string Maximum length: 1024

ForwarderZone (schema)

Name Description Type Notes
source_ip Source ip of the forwarder

The source ip used by the fowarder of the zone. If no source ip
specified, the ip address of listener of the dns forwarder will
be used.
IPv4Address
upstream_servers Ips of upsteam dns servers

Ip address of the upstream dns servers the dns forwarder accesses.
array of IPv4Address Required
Minimum items: 1
Maximum items: 3

GatewayConfig (schema)

Gateway configuration

Stores gateway configuration like nsx_manager_connection,
default_quarantine_policy_enabled and is_ha_enabled.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cloud_fallback_security_group_id Id of cloud security group

Id of security group where the VMs should be moved after last gateway
undeployed.
string
default_quarantine_policy_enabled Flag to identify if default quarantine policy is enabled boolean
dns_settings DNS settings

Settings related to Cloud gateway DNS configuration. This determines
DNS configuration based on dns_mode.
DnsSettings
is_ha_enabled Flag to identify if HA is enabled boolean
nsx_manager_connection NSX Manager connection

Determines if connection to NSX Manager is via public IP or private IP
string Enum: PUBLIC_IP, PRIVATE_IP
proxy_server_profile Id of the proxy server profile

Id of the proxy server profile, corresponding proxy settings
will be applied while deploying the gateway.
string
vpn_service_enabled Flag to enable or disable inter-operation with services via VPN

Flag that will enable or disable inter-operation between NSX and
non-NSX services via VPN.
boolean Default: "True"

GatewayInstanceStatus (schema)

Gateway instance status

Stores information about gateway instance status

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
deployment_step Different states of gateway deployment string Readonly
Enum: VALIDATING_ENVIRONMENT, COPYING_IMAGE, CREATING_SECURITY_GROUPS, LAUNCHING_GATEWAY, CREATING_NETWORK_INTERFACES, ATTACHING_NETWORK_INTERFACES, ATTACHING_SECURITY_GROUPS, CONFIGURING_GATEWAY, CREATING_LOGICAL_NETWORK_CONSTRUCTS, DEPLOYMENT_SUCCESSFUL, DEPLOYMENT_FAILED, UNCONFIGURING_GATEWAY, RELEASING_EIPS, TERMINATING_GATEWAY, DELETING_SECURITY_GROUPS, DELETING_CLOUD_RESOURCES, UNDEPLOYMENT_SUCCESSFUL, UNDEPLOYMENT_FAILED, NOT_APPLICABLE
error_code Error code for gateway deployment/undeployment failure integer Readonly
error_message Error message for gateway deployment/undeployment failure string Readonly
gateway_ha_index Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway. integer
gateway_instance_id ID of the gateway instance string
gateway_lcp_connectivity_status Gateway to NSX Controller connectivity status

Status of connectivity between NSX controller and public cloud gateway.
string Readonly
Enum: UP, DOWN, DEGRADED, UNKNOWN
gateway_mpa_connectivity_status Gateway to NSX Manager connectivity status

Status of connectivity between NSX manager and public cloud gateway.
string Readonly
Enum: UP, DOWN, UNKNOWN
gateway_name Name of the gateway instance string
gateway_node_id NSX Node ID of the public cloud gateway string
gateway_status Gateway instance status string Readonly
Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING
gateway_tn_id NSX transport node id of the public cloud gateway string
is_gateway_active Flag to identify if this is an active gateway boolean Readonly
private_ip Private IP address of the virtual machine string Readonly
public_ip Public IP address of the virtual machine string Readonly
vpn_private_ip VPN Private IP address

Private IP address of the virtual machine for VPN		 string Readonly

GatewayPublicIp (schema)

Gateway Public IP Information

Stores gateway public IP settings like ip_allocation_mode and ip_address.

Name Description Type Notes
ip_allocation_mode IP Allocation Mode

ALLOCATE_NEW: Allocate new public IP.
USE_EXISTING: Use cloud provider public IP.
DONT_ALLOCATE: Don't allocate any public IP.
string Enum: ALLOCATE_NEW, USE_EXISTING, DONT_ALLOCATE
Default: "ALLOCATE_NEW"
public_ip Public IP Address

Stores IP address from the Azure public IP service.
The IP address will be used ip_allocation_mode is set to USE_EXISTING.
string

GatewayStats (schema)

Gateway statistics

Name Description Type Notes
deploying Gateways with status DEPLOYING

The number of gateways with status DEPLOYING.		 integer Readonly
down Gateways with status DOWN

The number of gateways with status DOWN.		 integer Readonly
up Gateways with status UP

The number of gateways with status UP.		 integer Readonly

GenericDhcpOption (schema)

Name Description Type Notes
code dhcp option code, [0-255] integer Required
Minimum: 0
Maximum: 255
values dhcp option value array of string Required
Minimum items: 1
Maximum items: 10

GetCertParameter (schema)

Name Description Type Notes
details whether to expand the pem data and show all its details boolean Default: "False"

GlobalCollectionConfiguration (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
aggregated_data_collection_frequency Aggregated Data Collection Frequency In Seconds

The frequency in seconds at which data, which is subject to the aggregation function, is collected.		 integer Required
Minimum: 60
Maximum: 86400
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_data_collection_enabled Is data collection enabled

Indicates whether data collection required by the aggregation service is enabled. If false, no aggregation service data will be collected. Changing this property will not affect the existing data collection frequency settings.		 boolean Required
modified_feature_stack_collection_configurations Modified feature stack collection configurations

The list of the locally modified feature stack data collection frequency settings. If all feature stack data collection configurations are set to their default values, this list will be empty.		 FeatureStackCollectionConfigurationList Readonly
resource_type Must be set to the value GlobalCollectionConfiguration string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

GlobalRestoreStatus (schema)

Overall restore process status

Name Description Type Notes
description A description of the restore status string Required
Readonly
value Global rolled-up restore status value string Required
Readonly
Enum: NOT_AVAILABLE, NOT_STARTED, SUCCESS, ERROR, RUNNING, SUSPENDING, SUSPENDED, ABORTED

GridConfiguration (schema)

Grid Configuration

Represents configuration of a Grid or Table widget.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
columns Columns

Array of columns of a Grid widget		 array of ColumnItem Required
datasources Array of Datasource Instances with their relative urls

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.		 array of Datasource Minimum items: 0
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
drilldown_id Id of drilldown widget

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.		 string Maximum length: 255
footer Footer
id Unique identifier of this resource string Readonly
Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.		 boolean Default: "False"
page_size Page Size

Number of records per page. page_size will be effective only when the urls provided in the datasource support paging.		 int Default: "30"
resource_type Must be set to the value GridConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration
Maximum length: 255
row_list_fields List of fields from which rows are formed

Rows of grid or table are formed from the list of objects returned by a row list field.		 array of RowListField Required
Minimum items: 1
shared Visiblity of widgets to other users

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.		 boolean Deprecated
span Horizontal width of grid widget

Represents the horizontal span of the Grid.		 int Default: "2"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.		 int Deprecated

GroupStatusListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
has_errors Flag to indicate whether to return only upgrade units with errors boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

HaVipConfig (schema)

Name Description Type Notes
enabled Flag to enable this ha vip config. boolean Default: "True"
ha_vip_subnets Floating IP address subnets

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.		 array of VIPSubnet Required
Minimum items: 1
Maximum items: 1
redundant_uplink_port_ids Identifiers of uplink ports for providing redundancy

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).		 array of string Required

HostAggregateInfo (schema)

Aggregation of desired and runtime status of host

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
host Host attributes HostNode Readonly
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value HostAggregateInfo string
status Host status NodeStatus Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_node TransportNode Readonly

HostAggregateInfoListResult (schema)

Host aggregate state list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Host Aggregate Info Results array of HostAggregateInfo Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

HostInfraTrafficType (schema)

Enumerate all types of traffic

The traffic_name specifies the infrastructure traffic type and it
must be one of the following system-defined types:
FAULT_TOLERANCE is traffic for failover and recovery.
HBR is traffic for Host based replication.
ISCSI is traffic for Internet Small Computer System Interface.
MANAGEMENT is traffic for host management.
NFS is traffic related to file transfer in network file system.
VDP is traffic for vSphere data protection.
VIRTUAL_MACHINE is traffic generated by virtual machines.
VMOTION is traffic for computing resource migration.
VSAN is traffic generated by virtual storage area network.
The dynamic_res_pool_name provides a name for the resource pool.
It can be any arbitrary string.
Either traffic_name or dynamic_res_pool_name must be set.
If both are specified or omitted, an error will be returned.

Name Description Type Notes
dynamic_res_pool_name Dynamic resource pool traffic name string
traffic_name Traffic types string Enum: FAULT_TOLERANCE, HBR, ISCSI, MANAGEMENT, NFS, VDP, VIRTUAL_MACHINE, VMOTION, VSAN

HostNode (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
discovered_ip_addresses Discovered IP Addresses of the fabric node, version 4 or 6 array of IPAddress Readonly
discovered_node_id Id of the discovered node which was converted to create this node string Readonly
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id ID of the Node maintained on the Node and used to recognize the Node string
fqdn Fully qualified domain name of the fabric node string Readonly
host_credential Login credentials for the host HostNodeLoginCredential
id Unique identifier of this resource string Readonly
Sortable
ip_addresses IP Addresses of the Node, version 4 or 6

IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for
automatic deployment of edge virtual machine node. For automatic deployment, the ip address from
management_port_subnets property will be considered.
array of IPAddress
managed_by_server The id of the virtual center server managing the ESXi type HostNode. string Readonly
os_type Hypervisor type, for example ESXi or RHEL KVM. string Required
Enum: ESXI, RHELKVM, UBUNTUKVM, HYPERV, RHELCONTAINER, RHELSERVER, UBUNTUSERVER, CENTOSSERVER, CENTOSKVM
os_version The version of the hypervisor operating system. string
resource_type Must be set to the value HostNode string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

HostNodeLoginCredential (schema)

The credentials to login into the host node

Name Description Type Notes
password The authentication password of the host node string
thumbprint ESXi thumbprint or SSH key fingerprint of the host node

For ESXi hosts, the thumbprint of the ESXi management service.
For KVM hosts, the SSH key fingerprint.
string
username The username of the account on the host node string

HostProfileNetworkMigrationSpec (schema)

Specification for network migrations related with Host Profiles.

This specification should be used to define which VMK adapters need to be
migrated to NSX logical switches from VC network switches. Migrations specified
here should match with those from associated Host Profiles from VC.
Mismatch will result in migration failures.
This specification only supports migration vmkernal adapters to NSX logical switches.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
network_mappings List of VMkernal adapters to logical switch mappings.

Based on provided mappings, VMkernal adapters will be migrated to mentioned
logical switch. Without mappings specification doesn't make any sense, hence
minium one mapping should be specified. Assuming some sane value of 10 maximum
migrations which will be supported by any single specification.
array of VmkToLogicalSwitchMapping Minimum items: 1
Maximum items: 10
resource_type Must be set to the value HostProfileNetworkMigrationSpec NetworkMigrationSpecType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

HostSwitch (schema)

Host Switch specification

Name Description Type Notes
host_switch_name HostSwitch name. This name will be used to reference this HostSwitch.

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.		 string Default: "nsxDefaultHostSwitch"
host_switch_profile_ids Id's of HostSwitch profiles to be associated with this HostSwitch.

HostSwitch profiles bound to this HostSwitch. 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 HostSwitch.		 array of HostSwitchProfileTypeIdEntry
pnics Physical NICs connected to the host switch array of Pnic
static_ip_pool_id ID of already configured Static IP Pool.

ID of configured Static IP Pool. If specified allocate IP for Endpoints from Pool. Else assume IP will be assigned for Endpoints from DHCP. This field is deprecated, use ip_assignment_spec field instead.		 string Deprecated

HostSwitchProfileListParameters (schema)

HostSwitchProfile List Parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
hostswitch_profile_type Type of host switch profile HostSwitchProfileType
include_system_owned Whether the list result contains system resources boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
uplink_teaming_policy_name The host switch profile's uplink teaming policy name

If populated, only UplinkHostSwitchProfiles with the specified uplink teaming policy name are returned. Otherwise, any HostSwitchProfile can be returned.		 string

HostSwitchProfileType (schema)

Supported HostSwitch profiles.

Name Description Type Notes
HostSwitchProfileType Supported HostSwitch profiles. string Enum: UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile, ExtraConfigHostSwitchProfile

HostSwitchProfileTypeIdEntry (schema)

Name Description Type Notes
key HostSwitchProfileType
value key value string Required

HostSwitchProfilesListResult (schema)

HostSwitch Profile queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results HostSwitch Profile Results array of BaseHostSwitchProfile
(Abstract type: pass one of the following concrete types)
ExtraConfigHostSwitchProfile
LldpHostSwitchProfile
NiocProfile
UplinkHostSwitchProfile		 Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

HostSwitchSpec (schema)

Abstract base type for transport node host switch specification

The HostSwitchSpec is the base class for standard and preconfigured
host switch specifications.
This is an abstract type. Concrete child types:
PreconfiguredHostSwitchSpec
StandardHostSwitchSpec

Name Description Type Notes
resource_type string Required
Enum: StandardHostSwitchSpec, PreconfiguredHostSwitchSpec

HostSwitchState (schema)

Host Switch State

Name Description Type Notes
endpoints List of virtual tunnel endpoints which are configured on this switch array of Endpoint Readonly
host_switch_id External ID of the HostSwitch string Readonly
host_switch_name HostSwitch name. This name will be used to reference this HostSwitch.

The name must be unique among all host switches specified in a given Transport Node.		 string Readonly
transport_zone_ids List of Ids of TransportZones this HostSwitch belongs to array of string Readonly

HostUpgradeStatus (schema)

Status of host upgrade

Name Description Type Notes
can_skip Can the upgrade of the remaining units in this component be skipped boolean Readonly
component_type Component type for the upgrade status string Readonly
details Details about the upgrade status string Readonly
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
status Upgrade status of component string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

HostnameOrIPv4Address (schema)

Hostname or IPv4 address

Name Description Type Notes
HostnameOrIPv4Address Hostname or IPv4 address string

HostnameOrIPv4AddressOrEmptyString (schema)

Hostname or IPv4 address

Name Description Type Notes
HostnameOrIPv4AddressOrEmptyString Hostname or IPv4 address string Maximum length: 255
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])?)*\.?$|^$"

HttpProtocol (schema)

Name Description Type Notes
authentication_scheme Scheme to authenticate if required BasicAuthenticationScheme
name Must be set to the value HttpProtocol string Required
Enum: http, https, scp, sftp

HttpRequestMethodType (schema)

http monitor method

Name Description Type Notes
HttpRequestMethodType http monitor method string Enum: GET, OPTIONS, POST, HEAD, PUT

HttpRequestVersionType (schema)

http request version

Name Description Type Notes
HttpRequestVersionType http request version string Enum: HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP_VERSION_2_0

HttpServiceProperties (schema)

HTTP Service properties

Name Description Type Notes
certificate Certificate Required
Readonly
cipher_suites Cipher suites used to secure contents of connection array of CipherSuite Minimum items: 1
client_api_concurrency_limit Client API rate limit in calls

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.		 integer Minimum: 0
Default: "40"
client_api_rate_limit Client API rate limit in calls per second

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.		 integer Minimum: 0
Default: "100"
connection_timeout NSX connection timeout, set to 0 to configure no timeout integer Minimum: 0
Maximum: 2147483647
global_api_concurrency_limit Global API rate limit in calls

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.		 integer Minimum: 0
Default: "100"
protocol_versions TLS protocol versions array of ProtocolVersion Minimum items: 1
redirect_host Host name or IP address to use for redirect location headers, or empty string to derive from current request HostnameOrIPv4AddressOrEmptyString Default: ""
session_timeout NSX session inactivity timeout, set to 0 to configure no timeout integer Minimum: 0
Maximum: 2147483647

HttpsProtocol (schema)

Name Description Type Notes
authentication_scheme Scheme to authenticate if required BasicAuthenticationScheme
name Must be set to the value HttpsProtocol string Required
Enum: http, https, scp, sftp
sha256_thumbprint SSL thumbprint of server string Required

ICMPTypeNSService (schema)

A NSService that represents IPv4 or IPv6 ICMP protocol

Name Description Type Notes
icmp_code ICMP message code integer
icmp_type ICMP message type integer
protocol ICMP protocol type string Required
Enum: ICMPv4, ICMPv6
resource_type Must be set to the value ICMPTypeNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

IGMPTypeNSService (schema)

A NSService that represents IGMP protocol

Name Description Type Notes
resource_type Must be set to the value IGMPTypeNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

IKEDigestAlgorithm (schema)

Digest Algorithms used in IKE negotiations

The IKEDigestAlgorithms are used to verify message
integrity during IKE negotiation. SHA1 produces 160
bits hash and SHA2_XXX produces XXX bit hash.

Name Description Type Notes
IKEDigestAlgorithm Digest Algorithms used in IKE negotiations

The IKEDigestAlgorithms are used to verify message
integrity during IKE negotiation. SHA1 produces 160
bits hash and SHA2_XXX produces XXX bit hash.
string Enum: SHA1, SHA2_256, SHA2_384, SHA2_512

IKEEncryptionAlgorithm (schema)

Encryption algorithms used in IKE

IKEEncryption algorithms are used to ensure confidentiality of
the messages exchanged during IKE negotiations. AES stands for
Advanced Encryption Standards. AES_128 uses 128-bit keys whereas
AES_256 uses 256-bit keys for encryption and decryption.
AES_GCM stands for Advanced Encryption Standard(AES) in
Galois/Counter Mode(GCM) and is used to provide both
confidentiality and data origin authentication. AES_GCM composed
of two separate functions one for encryption(AES) and one for
authentication(GMAC). AES_GCM algorithms will be available with
IKE_V2 version only.
AES_GCM_128 uses 128-bit keys.
AES_GCM_192 uses 192-bit keys.
AES_GCM_256 uses 256-bit keys.

Name Description Type Notes
IKEEncryptionAlgorithm Encryption algorithms used in IKE

IKEEncryption algorithms are used to ensure confidentiality of
the messages exchanged during IKE negotiations. AES stands for
Advanced Encryption Standards. AES_128 uses 128-bit keys whereas
AES_256 uses 256-bit keys for encryption and decryption.
AES_GCM stands for Advanced Encryption Standard(AES) in
Galois/Counter Mode(GCM) and is used to provide both
confidentiality and data origin authentication. AES_GCM composed
of two separate functions one for encryption(AES) and one for
authentication(GMAC). AES_GCM algorithms will be available with
IKE_V2 version only.
AES_GCM_128 uses 128-bit keys.
AES_GCM_192 uses 192-bit keys.
AES_GCM_256 uses 256-bit keys.
string Enum: AES_128, AES_256, AES_GCM_128, AES_GCM_192, AES_GCM_256

IPAddress (schema)

IPv4 or IPv6 address

Name Description Type Notes
IPAddress IPv4 or IPv6 address string

IPElement (schema)

IP address, range, or subnet

IPElement can be a single IP address, IP address range or a Subnet. Its
type can be of IPv4 or IPv6. Supported list of formats are "192.168.1.1",
"192.168.1.1-192.168.1.100", "192.168.0.0/24",
"fe80::250:56ff:fe83:318c",
"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c",
"fe80::250:56ff:fe83:318c/64"

Name Description Type Notes
IPElement IP address, range, or subnet

IPElement can be a single IP address, IP address range or a Subnet. Its
type can be of IPv4 or IPv6. Supported list of formats are "192.168.1.1",
"192.168.1.1-192.168.1.100", "192.168.0.0/24",
"fe80::250:56ff:fe83:318c",
"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c",
"fe80::250:56ff:fe83:318c/64"
string

IPInfo (schema)

Name Description Type Notes
ip_addresses IPv4 Addresses array of IPv4Address Required
Minimum items: 1
Maximum items: 1
prefix_length Subnet Prefix Length integer Required
Minimum: 1
Maximum: 32

IPMirrorDestination (schema)

Name Description Type Notes
destination_ips List of destination IP addresses

The destination IPs of the mirror packet will be sent to.		 array of IPAddress Required
Minimum items: 1
Maximum items: 3
encapsulation_type IPMirrorDestination encapsulation type

You can choose GRE, ERSPAN II or ERSPAN III.		 EncapsulationType Required
Default: "GRE"
erspan_id ERSPAN session id

Used by physical switch for the mirror traffic forwarding.
Must be provided and only effective when encapsulation type is
ERSPAN type II or type III.
int Minimum: 0
Maximum: 1023
gre_key GRE encapsulation key

User-configurable 32-bit key only for GRE		 int
resource_type Must be set to the value IPMirrorDestination MirrorDestinationResourceType Required

IPPrefixList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
prefixes Ordered list of PrefixConfig array of PrefixConfig Required
Minimum items: 1
Maximum items: 1330000
resource_type Must be set to the value IPPrefixList string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IPPrefixListListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paginated list of IPPrefixLists array of IPPrefixList Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPProtocolNSService (schema)

An NSService element that represents an IP protocol

Name Description Type Notes
protocol_number The IP protocol number integer Required
resource_type Must be set to the value IPProtocolNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

IPSecVPNDPDProfile (schema)

Dead peer detection (DPD) profile

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
dpd_probe_interval DPD probe interval in seconds

DPD probe interval defines a periodic interval for DPD probes.		 integer Minimum: 3
Maximum: 360
Default: "60"
enabled Enable dead peer detection (DPD)

If true, enable dead peer detection.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IPSecVPNDPDProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IPSecVPNDPDProfileListResult (schema)

List dead peer detection (DPD) profiles

List all the dead peer detection (DPD) profiles.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPSec DPD Profile list results array of IPSecVPNDPDProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSecVPNIKEProfile (schema)

Internet key exchange (IKE) profile

IKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
dh_groups DH group

Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.		 array of DHGroup
digest_algorithms Algorithm for message hash

Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.		 array of IKEDigestAlgorithm
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
encryption_algorithms Encryption algorithm for IKE

Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.		 array of IKEEncryptionAlgorithm
id Unique identifier of this resource string Readonly
Sortable
ike_version IKE version

IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.		 string Enum: IKE_V1, IKE_V2, IKE_FLEX
Default: "IKE-V2"
resource_type Must be set to the value IPSecVPNIKEProfile string
sa_life_time Security association (SA) life time

Life time for security association. Default is 86400 seconds (1 day).		 integer Minimum: 21600
Maximum: 31536000
Default: "86400"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IPSecVPNIKEProfileListResult (schema)

List IKE profiles

List all the IKE profiles.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IKE Profile list results array of IPSecVPNIKEProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSecVPNLocalEndpoint (schema)

IPSec VPN Local Endpoint

Local endpoint represents a logical router on which tunnel needs to be terminated.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
certificate_id Certificate Id

Site certificate identifier. Field is marked for future use. Certificate based authentication is not supported.		 string
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
ipsec_vpn_service_id VPN Service id

VPN Service id.		 ResourceReference Required
local_address IPV4 Address for local endpoint

IPV4 Address for local endpoint.		 IPv4Address Required
local_id Local identifier

Local identifier.		 string
resource_type Must be set to the value IPSecVPNLocalEndpoint string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
trust_ca_ids Certificate authority (CA) identifiers

Certificate authority (CA) identifier list to verify peer certificates. Field is marked for future use. Certificate based authentication is not supported.		 array of string
trust_crl_ids Certificate revocation list (CRL) Identifiers

Certificate revocation list (CRL) identifier list to peer certificates. Field is marked for future use. Certificate based authentication is not supported.		 array of string

IPSecVPNLocalEndpointListParameters (schema)

List parameters for IPSec VPN local endpoints

Parameters to get the filtered list of IPSec VPN local endpoints. Both filter parameters can be provided as they are not mutually exclusive.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
ipsec_vpn_service_id Id of the IPSec VPN service

All the local endpoints configured with the specified VPN Service id will be included in the result.		 string
logical_router_id Id of logical router

All the local endpoints belonging to the specified logical router id will be included in the result.		 string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

IPSecVPNLocalEndpointListResult (schema)

List local endpoints

List all the local endpoints.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPSec local endpoint list results array of IPSecVPNLocalEndpoint Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSecVPNPeerEndpoint (schema)

IPSec VPN Peer Endpoint

IPSec VPN Peer Endpoint covers configuration to be applied locally to establish a session with remote endpoint on peer site.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
authentication_mode Authentication Mode

For peer authentication only Pre shared key (PSK) mode will be supported.		 string Enum: PSK
Default: "PSK"
connection_initiation_mode Connection initiation mode

Connection initiation mode used by local
endpoint to establish ike connection with peer endpoint.
INITIATOR - In this mode local endpoint initiates tunnel
setup and will also respond to incoming tunnel setup requests
from peer gateway.
RESPOND_ONLY - In this mode, local endpoint shall only
respond to incoming tunnel setup requests. It shall not
initiate the tunnel setup.
ON_DEMAND - In this mode local endpoint will initiate tunnel
creation once first packet matching the policy rule is
received and will also respond to incoming initiation request.
string Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND
Default: "INITIATOR"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
dpd_profile_id Dead peer detection (DPD) profile id

Dead peer detection (DPD) profile id. Default will be set according to system default policy.		 string
id Unique identifier of this resource string Readonly
Sortable
ike_profile_id Internet key exchange (IKE) profile id

IKE profile id to be used. Default will be set according to system default policy.		 string
ipsec_tunnel_profile_id IPSec tunnel profile id

Tunnel profile id to be used. By default it will point to system default profile.		 string
peer_address IPV4 address of peer endpoint on remote site.

IPV4 address of peer endpoint on remote site.		 string Required
peer_id Peer id

Peer identifier.		 string Required
psk Pre-shared key

IPSec Pre-shared key. Maximum length of this field is 128 characters.		 string
resource_type Must be set to the value IPSecVPNPeerEndpoint string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IPSecVPNPeerEndpointListResult (schema)

List peer endpoints

List all the peer endpoints.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPSec Peer endpoint list results array of IPSecVPNPeerEndpoint Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSecVPNPolicyRule (schema)

IPSec VPN policy rules

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.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_owner Owner of this resource OwnerResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
action Action to be applied

PROTECT - Protect rules are defined per policy based
IPSec VPN session.
BYPASS - Bypass rules are defined per IPSec VPN
service and affects all policy based IPSec VPN sessions.
Bypass rules are prioritized over protect rules.
string Readonly
Enum: PROTECT, BYPASS
Default: "PROTECT"
description Description of this resource string Maximum length: 1024
Sortable
destinations Destination list

List of peer subnets.		 array of IPSecVPNPolicySubnet Maximum items: 128
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enabled flag

A flag to enable/disable the policy rule.		 boolean Default: "True"
id Unique policy id

Unique policy id.		 string
logged Logging flag

A flag to enable/disable the logging for the policy rule.		 boolean Default: "False"
resource_type Must be set to the value IPSecVPNPolicyRule string
sources Source list

List of local subnets.		 array of IPSecVPNPolicySubnet Maximum items: 128

IPSecVPNPolicySubnet (schema)

Subnet for IPSec Policy based VPN

Used to specify the local/peer subnets in IPSec VPN Policy rule.

Name Description Type Notes
subnet Peer or local subnet

Subnet used in policy rule.		 IPv4CIDRBlock Required

IPSecVPNService (schema)

IPSec VPN service

Create and manage IPSec VPN service for given logical router.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
bypass_rules Bypass Policy rules

Bypass policy rules are configured using VPN service.
Bypass rules always have higher priority over protect
rules and they affect all policy based vpn sessions associated
with the IPSec VPN service. Protect rules are defined per
policy based vpn session.
array of IPSecVPNPolicyRule
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enable virtual private network (VPN) service

If true, enable VPN services for given logical router.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
ike_log_level Internet key exchange (IKE) log level

Log level for internet key exchange (IKE).		 string Enum: DEBUG, INFO, WARN, ERROR, EMERGENCY
Default: "INFO"
logical_router_id Logical router id

Logical router id.		 string Required
resource_type Must be set to the value IPSecVPNService string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IPSecVPNServiceListResult (schema)

List IPSec VPN services

List all the IPSec VPN services.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPSec VPN serivce list result array of IPSecVPNService Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSecVPNSession (schema)

IPSec VPN session

VPN session defines connection between local and peer endpoint. Untill VPN session is defined configuration is not realized. This is an abstract type. Concrete child types:
PolicyBasedIPSecVPNSession
RouteBasedIPSecVPNSession

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enable/Disable IPSec VPN session

Enable/Disable IPSec VPN session.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
ipsec_vpn_service_id IPSec VPN service identifier

Identifier of VPN Service linked with local endpoint.		 string Readonly
local_endpoint_id Local endpoint identifier

Local endpoint identifier.		 string Required
peer_endpoint_id Peer endpoint identifier

Peer endpoint identifier.		 string Required
resource_type Must be set to the value IPSecVPNSession IPSecVPNSessionResourceType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IPSecVPNSessionListParameters (schema)

List parameters for IPSec VPN Sessions

Parameters to get filtered list of IPSec VPN Sessions. The filter parameters are not mutually exclusive and can be used together.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
ipsec_vpn_service_id Id of the IPSec VPN service

All the IPSec VPN sessions configured with the specified VPN Service id will be included in the result.		 string
logical_router_id Id of logical router

All the VPN sessions belonging to the specified logical router id will be included in the result.		 string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
session_type Type of the vpn session

All the IPSec VPN sessions of specified type will be included in the result.		 IPSecVPNSessionResourceType
sort_ascending boolean
sort_by Field by which records are sorted string

IPSecVPNSessionListResult (schema)

List IPSec VPN sessions

List all the IPSec VPN sessions.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPSec VPN sessions list result array of IPSecVPNSession
(Abstract type: pass one of the following concrete types)
PolicyBasedIPSecVPNSession
RouteBasedIPSecVPNSession		 Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSecVPNSessionResourceType (schema)

Resource types of IPsec VPN session

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.
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.

Name Description Type Notes
IPSecVPNSessionResourceType Resource types of IPsec VPN session

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.
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.
string Enum: PolicyBasedIPSecVPNSession, RouteBasedIPSecVPNSession

IPSecVPNTunnelProfile (schema)

IPSec VPN tunnel profile

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
df_policy Policy for handling defragmentation bit

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.		 string Enum: COPY, CLEAR
Default: "COPY"
dh_groups DH group

Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.		 array of DHGroup
digest_algorithms Algorithm for message hash

Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm "AES_GCM_128".		 array of TunnelDigestAlgorithm
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enable_perfect_forward_secrecy Enable perfect forward secrecy

If true, perfect forward secrecy (PFS) is enabled.		 boolean Default: "True"
encapsulation_mode Encapsulation Mode

Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet.		 string Readonly
Enum: TUNNEL_MODE
Default: "TUNNEL_MODE"
encryption_algorithms Encryption algorithm to use in tunnel establishement

Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.		 array of TunnelEncryptionAlgorithm
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IPSecVPNTunnelProfile string
sa_life_time Security association (SA) life time

SA life time specifies the expiry time of security
association. Default is 3600 seconds.
integer Minimum: 900
Maximum: 31536000
Default: "3600"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transform_protocol Tunnel protocol

IPSec transform specifies IPSec security protocol.		 string Readonly
Enum: ESP
Default: "ESP"

IPSecVPNTunnelProfileListResult (schema)

List tunnel profiles

List all the tunnel profiles.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPSec Tunnel Profile list results array of IPSecVPNTunnelProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSet (schema)

Set of one or more IP addresses

IPSet is used to group individual IP addresses, range of IP addresses or subnets.
An IPSet is a homogeneous group of IP addresses, either of type IPv4 or of type
IPv6. IPSets can be used as source or destination in firewall rules. These can
also be used as members of NSGroups.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
ip_addresses IP addresses array of IPElement Maximum items: 4000
resource_type Must be set to the value IPSet string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IPSetListRequestParameters (schema)

IPSet list request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

IPSetListResult (schema)

Paged collection of IPSets

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPSet list results array of IPSet Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IPSubnet (schema)

Name Description Type Notes
ip_addresses IPv4 Addresses array of IPv4Address Required
Minimum items: 1
Maximum items: 1
prefix_length Subnet Prefix Length integer Required
Minimum: 1
Maximum: 32

IPv4Address (schema)

IPv4 address

Name Description Type Notes
IPv4Address IPv4 address string

IPv4AddressProperties (schema)

IPv4 address properties

Name Description Type Notes
ip_address Interface IPv4 address string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
netmask Interface netmask string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"

IPv4CIDRBlock (schema)

IPv4 CIDR Block

Name Description Type Notes
IPv4CIDRBlock IPv4 CIDR Block string

IPv4DhcpServer (schema)

Name Description Type Notes
dhcp_server_ip dhcp server ip in cidr format IPv4CIDRBlock Required
dns_nameservers dns ips array of IPv4Address Minimum items: 0
Maximum items: 2
domain_name domain name string
gateway_ip gateway ip IPv4Address
options dhcp options

Defines the default options for all ip-pools and static-bindings of this server.
These options will be ignored if options are defined for ip-pools or static-bindings.
DhcpOptions

Icon (schema)

Icon

Icon to be applied at dashboard for widgets and UI elements.

Name Description Type Notes
placement Position at which to display icon, if any

If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.		 string Enum: PRE, POST
Default: "PRE"
tooltip Multi-line tooltip

Multi-line text to be shown on tooltip while hovering over the icon.		 array of Tooltip
type Type of icon

Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered.		 string Enum: ERROR, WARNING, INFO, INPROGRESS, SUCCESS, DETAIL, NOT_AVAILABLE

IncludedFieldsParameters (schema)

A list of fields to include in query results

Name Description Type Notes
included_fields Comma separated list of fields that should be included in query result string

IngressBroadcastRateShaper (schema)

A shaper that specifies ingress rate properties in kb/s

Name Description Type Notes
average_bandwidth_kbps Average bandwidth in kb/s int Minimum: 0
Default: "0"
burst_size_bytes Burst size in bytes int Minimum: 0
Default: "0"
enabled boolean Required
peak_bandwidth_kbps Peak bandwidth in kb/s int Minimum: 0
Default: "0"
resource_type Must be set to the value IngressBroadcastRateShaper string Enum: IngressRateShaper, IngressBroadcastRateShaper, EgressRateShaper
Default: "IngressRateShaper"

IngressRateShaper (schema)

A shaper that specifies ingress rate properties in Mb/s

Name Description Type Notes
average_bandwidth_mbps Average bandwidth in Mb/s int Minimum: 0
Default: "0"
burst_size_bytes Burst size in bytes int Minimum: 0
Default: "0"
enabled boolean Required
peak_bandwidth_mbps Peak bandwidth in Mb/s int Minimum: 0
Default: "0"
resource_type Must be set to the value IngressRateShaper string Enum: IngressRateShaper, IngressBroadcastRateShaper, EgressRateShaper
Default: "IngressRateShaper"

InitiateClusterRestoreRequest (schema)

Name Description Type Notes
node_id Unique id of the backed-up configuration from which the appliance will be restored string Required
Readonly
timestamp Timestamp of the backed-up configuration from which the appliance will be restored EpochMsTimestamp Required
Readonly

InstallUpgradeServiceProperties (schema)

install-upgrade service properties

Name Description Type Notes
enabled True if service enabled; otherwise, false boolean Required
enabled_on IP of manager on which install-upgrade is enabled string Readonly

InstalledAppsParameters (schema)

Name Description Type Notes
app_profile_id string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
vm_id string

InstanceDeploymentConfig (schema)

Instance Deployment Config

The Instance Deployment Config contains settings that is applied during install time.

Name Description Type Notes
compute_id compute id

Resource Pool or Compute Id.		 string Required
context_id Context Id

Context Id or VCenter Id.		 string Required
storage_id storage id

Storage Id.		 string Required
vm_nic_infos List of VM NIC information

List of set of NIC information for VMs		 array of VmNicInfo Required
Minimum items: 1
Maximum items: 2

InstanceEndpoint (schema)

EndPoint of an Instance

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
endpoint_type Instance Endpoint Type

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.		 string Enum: LOGICAL, VIRTUAL
Default: "LOGICAL"
id Unique identifier of this resource string Readonly
Sortable
link_ids Link Id list

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.		 array of ResourceReference Minimum items: 1
Maximum items: 1
resource_type Must be set to the value InstanceEndpoint string
service_attachments Service Attachment list

Id(s) of the Service Attachment where this enndpoint is connected to. Service Attachment is mandatory for LOGICAL Instance Endpoint.		 array of ResourceReference Minimum items: 1
Maximum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
target_ips Target IPs

Target IPs on an interface of the Service Instance.		 array of IPInfo Required
Minimum items: 1
Maximum items: 1

InstanceEndpointListResult (schema)

Instance Endpoint List

List of instance endpoints.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Instance End Point list

List of instance endpoints.		 array of InstanceEndpoint Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

InstanceRuntime (schema)

Runtime of a Service-Instance.

A Service Runtime is the runtime entity associated with ever Service-VM deployed.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
deployment_status Instance Runtime deployment status

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.		 string Readonly
Enum: DEPLOYMENT_IN_PROGRESS, DEPLOYMENT_FAILED, DEPLOYMENT_SUCCESSFUL, UPGRADE_IN_PROGRESS, UPGRADE_FAILED, UNDEPLOYMENT_IN_PROGRESS, UNDEPLOYMENT_FAILED, UNDEPLOYMENT_SUCCESSFUL, UNKNOWN
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
error_message Error Message

Error message for the Service Instance Runtime if any.		 string Readonly
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value InstanceRuntime string
runtime_status Instance Runtime Status

Service-Instance Runtime status of the deployed Service-VM.		 string Readonly
Enum: IN_SERVICE, OUT_OF_SERVICE, NEEDS_ATTENTION, NOT_AVAILABLE
service_instance_id Service instance id

Id of an instantiation of a registered service.		 string Readonly
service_vm_id Service VM id

Service-VM/SVM id of deployed virtual-machine.		 string Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vm_nic_info VM NIC info VmNicInfo Readonly

InstanceRuntimeListResult (schema)

InstanceRuntime list result

Result of List of InstanceRuntimes

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Results

Array of existing InstanceRuntimes in database
array of InstanceRuntime Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

InstanceStats (schema)

Instance statistics

Stores statistics of the instances like MANAGED and UNMANAGED instances.

Name Description Type Notes
error Error Instances

The number of instances with status ERROR.		 integer Readonly
managed Managed Instances

The number of instances with status MANAGED.		 integer Readonly
powered_off Powered Off Instances

The number of instances with status POWERED OFF.		 integer Readonly
total Total number of instances

The total number of instances.		 integer Readonly
unmanaged Unmanaged Instances

The number of instances with status UNMANAGED.		 integer Readonly
vcpus Virtual CPUs

The number of virtual CPUs.		 integer Readonly

InstructionInfo (schema)

Details of the instructions displayed during restore process

Name Description Type Notes
actions Actions list

A list of actions that are to be applied to resources		 array of string Required
Readonly
fields Displayable fields

A list of fields that are displayable to users in a table		 array of string Required
Readonly
id UUID of the instruction string Required
Readonly
name Instruction name string Required
Readonly

InterfaceNeighborProperties (schema)

Interface neighbor properties

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
ifindex Interface index integer Required
Readonly
mac Interface MAC address string Required
Readonly
Pattern: "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$"
name Interface Name string Required
Readonly
neighbors Neighbor properties array of NeighborProperties Readonly
resource_type Must be set to the value InterfaceNeighborProperties string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

InterfaceNeighborPropertyListResult (schema)

Interface neighbor property query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Interface neighbor property results array of InterfaceNeighborProperties
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

InterfaceStatistics (schema)

Statistics for a network interface

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
rx_bytes Count of bytes received on this port integer Readonly
rx_errors Count of receive errors occurring on this port integer Readonly
rx_packets Count of packets received on this port integer Readonly
tx_bytes Count of bytes transmitted on this port integer Readonly
tx_errors Count of transmit errors occurring on this port integer Readonly
tx_packets Count of packets transmitted on this port integer Readonly

IntervalBackupSchedule (schema)

Schedule to specify the interval time at which automated backups need to be taken

Name Description Type Notes
resource_type Must be set to the value IntervalBackupSchedule string Required
Enum: WeeklyBackupSchedule, IntervalBackupSchedule
seconds_between_backups Time interval in seconds between two consecutive automated backups integer Minimum: 300
Maximum: 86400
Default: "3600"

IpAddressInfo (schema)

Ipaddress information of the fabric node.

Name Description Type Notes
ip_addresses IP Addresses of the the virtual network interface, as discovered in the source. array of IPAddress Required
Readonly
source Source of the ipaddress information. string Required
Readonly
Enum: VM_TOOLS

IpAllocationBase (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
gateway_ip gateway ip IPAddress
id Unique identifier of this resource string Readonly
Sortable
lease_time lease time, in seconds, [60-(2^32-1)], default 86400 integer Minimum: 60
Maximum: 4294967295
Default: "86400"
options dhcp options

If an option is defined at server level and not configred at
ip-pool/static-binding level, the option will be inherited to
ip-pool/static-binding. If both define a same-code option, the
option defined at ip-pool/static-binding level take precedence
over that defined at server level.
DhcpOptions
resource_type Must be set to the value IpAllocationBase string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpAssignmentSpec (schema)

Abstract base type for specification of IPs to be used with host switch virtual tunnel endpoints

This is an abstract type. Concrete child types:
AssignedByDhcp
StaticIpListSpec
StaticIpMacListSpec
StaticIpPoolSpec

Name Description Type Notes
resource_type string Required
Enum: StaticIpPoolSpec, StaticIpListSpec, AssignedByDhcp, StaticIpMacListSpec

IpBlock (schema)

A block of IPv4 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 / (___________________________________________/________) / / =======================================================================

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
cidr Represents network address and the prefix length which will be associated with a layer-2 broadcast domain string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IpBlock string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpBlockListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IP block list results array of IpBlock Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpBlockSubnet (schema)

A set of IPv4 addresses defined by a start address and a mask/prefix which will typically be associated with a layer-2 broadcast domain.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
allocation_ranges A collection of IPv4 IP ranges used for IP allocation. array of IpPoolRange Readonly
block_id Block id for which the subnet is created. string Required
cidr Represents network address and the prefix length which will be associated with a layer-2 broadcast domain string Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IpBlockSubnet string
size Represents the size or number of ip addresses in the subnet integer Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpBlockSubnetListRequestParameters (schema)

Name Description Type Notes
block_id string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

IpBlockSubnetListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IP block subnet list results array of IpBlockSubnet Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpDiscoverySwitchingProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
arp_bindings_limit Number of arp snooped IP addresses

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.		 int Minimum: 1
Maximum: 128
Default: "1"
arp_snooping_enabled Indicates whether ARP snooping is enabled boolean Default: "True"
description Description of this resource string Maximum length: 1024
Sortable
dhcp_snooping_enabled Indicates whether DHCP snooping is enabled boolean Default: "True"
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value IpDiscoverySwitchingProfile string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vm_tools_enabled Indicates whether fetching IP using vm-tools is enabled

This option is only supported on ESX where vm-tools is installed.		 boolean Default: "False"

IpMacPair (schema)

IP and MAC pair.

Name Description Type Notes
ip IP address IPAddress Required
mac MAC address MACAddress

IpPool (schema)

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
pool_usage Pool usage statistics PoolUsage Readonly
resource_type Must be set to the value IpPool string
subnets The collection of one or more subnet objects in a pool

Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.		 array of IpPoolSubnet Maximum items: 5
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpPoolListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IP pool list results array of IpPool Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpPoolRange (schema)

A set of IPv4 or IPv6 addresses defined by a start and end address.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
end The end IP Address of the IP Range. IPAddress Required
start The start IP Address of the IP Range. IPAddress Required

IpPoolSubnet (schema)

A set of IPv4 or IPv6 addresses defined by a network CIDR.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
allocation_ranges A collection of IPv4 or IPv6 IP Pool Ranges. array of IpPoolRange Required
cidr Represents network address and the prefix length which will be associated with a layer-2 broadcast domain string Required
dns_nameservers The collection of upto 3 DNS servers for the subnet. array of IPAddress Maximum items: 3
dns_suffix The DNS suffix for the DNS server. string
gateway_ip The default gateway address on a layer-3 router. IPAddress

IpfixCollector (schema)

Name Description Type Notes
collector_ip_address IP address for the IPFIX collector IPAddress Required
collector_port Port for the IPFIX collector int Minimum: 0
Maximum: 65535
Default: "4739"

IpfixCollectorConfig (schema)

This managed entity contains a set of IPFIX collectors.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
collectors IPFIX Collectors array of IpfixCollector Required
Minimum items: 1
Maximum items: 4
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IpfixCollectorConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpfixCollectorConfigListResult (schema)

List of IPFIX Collector Configs

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPFIX Collector Config array of IpfixCollectorConfig Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpfixCollectorUpmProfile (schema)

IPFIX Collector Profile

The configuration for Internet protocol flow information export (IPFIX)
collector. It should be referenced in other IPFIX profile as a collecor
config. The IPFIX exporter will send records to these collectors.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
collectors IPFIX Collector Set array of IpfixCollector Required
Minimum items: 1
Maximum items: 4
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IpfixCollectorUpmProfile IpfixCollectorUpmProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpfixCollectorUpmProfileListParameters (schema)

IPFIX Collector Profile List Parameters

Query parameters for IPFIX collector profile list

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
profile_types IPFIX Collector Profile Type List

An English comma-separated list of profile types. Enumerated value in
IpfixCollectorUpmProfileType can be listed here as a filter param.
string
sort_ascending boolean
sort_by Field by which records are sorted string

IpfixCollectorUpmProfileListResult (schema)

List of IPFIX Collector Profiles

IPFIX collector profile list result for query with profile list parameters

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPFIX Collector Profile List array of IpfixCollectorUpmProfile Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpfixCollectorUpmProfileType (schema)

IPFIX Collector Profile Types

All IPFIX collector profile types.

Name Description Type Notes
IpfixCollectorUpmProfileType IPFIX Collector Profile Types

All IPFIX collector profile types.		 string Enum: IpfixCollectorUpmProfile

IpfixConfig (schema)

IPFIX Config base representation

This is an abstract type. Concrete child types:
IpfixDfwConfig
IpfixSwitchConfig

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
applied_tos AppliedTo List

List of objects where the IPFIX Config will be enabled.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IpfixConfig IpfixConfigType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpfixConfigListParameters (schema)

IPFIX Config List Parameters

Name Description Type Notes
applied_to Applied To

An applied to UUID working as listing condition		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
ipfix_config_type Type of IPFIX Config IpfixConfigType
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

IpfixConfigListResult (schema)

List of IPFIX Config

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPFIX Config array of IpfixConfig
(Abstract type: pass one of the following concrete types)
IpfixDfwConfig
IpfixSwitchConfig		 Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpfixConfigType (schema)

Supported IPFIX Config Types.

Name Description Type Notes
IpfixConfigType Supported IPFIX Config Types. string Enum: IpfixSwitchConfig, IpfixDfwConfig

IpfixDfwConfig (schema)

IPFIX Config for the DFW Module

It defines IPFIX DFW Configuration.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
active_flow_export_timeout Active flow export timeout (minutes)

For long standing active flows, IPFIX records will be sent per timeout period
integer Minimum: 1
Maximum: 60
Default: "1"
applied_tos AppliedTo List

List of objects where the IPFIX Config will be enabled.		 array of ResourceReference Maximum items: 128
collector UUID of IPFIX DFW Collector Config

Each IPFIX DFW config can have its own collector config.
string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
observation_domain_id Observation domain ID

An identifier that is unique to the exporting process and used to
meter the Flows.
integer Required
Minimum: 0
Maximum: 4294967295
priority Config Priority

This priority field is used to resolve conflicts in Logical Ports
which are covered by more than one IPFIX profiles. The IPFIX
exporter will send records to Collectors in highest priority
profile (lowest number) only.
integer Required
Minimum: 0
Maximum: 65536
Default: "0"
resource_type Must be set to the value IpfixDfwConfig IpfixConfigType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
template_parameters Template Parameters

An object that indicates whether each corresponding template parameter
is required or not.
IpfixDfwTemplateParameters

IpfixDfwTemplateParameters (schema)

IPFIX DFW Template Parameters

This entity represents the flow parameters which are exported.

Name Description Type Notes
destination_address The destination IP address of a monitored network flow.
boolean Readonly
Default: "True"
destination_transport_port The destination transport port of a monitored network flow.
boolean Readonly
Default: "True"
firewall_event Five valid values are allowed: 1. Flow Created. 2. Flow Deleted.
3. Flow Denied. 4. Flow Alert (not used in DropKick implementation).
5. Flow Update.
boolean Readonly
Default: "True"
flow_direction Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01:
egress flow from VM.
boolean Readonly
Default: "True"
flow_end The absolute timestamp (seconds) of the last packet of this flow.
boolean Readonly
Default: "True"
flow_start The absolute timestamp (seconds) of the first packet of this flow.
boolean Readonly
Default: "True"
icmp_code Code of the IPv4 ICMP message.
boolean Readonly
Default: "True"
octet_delta_count The number of octets since the previous report (if any) in incoming
packets for this flow at the observation point. The number of octets
include IP header(s) and payload.
boolean Readonly
Default: "True"
packet_delta_count The number of incoming packets since the previous report (if any)
for this flow at the observation point.
boolean Readonly
Default: "True"
protocol_identifier The value of the protocol number in the IP packet header.
boolean Readonly
Default: "True"
rule_id Firewall rule Id - enterprise specific Information Element that uniquely identifies
firewall rule.
boolean Readonly
Default: "True"
source_address The source IP address of a monitored network flow.
boolean Readonly
Default: "True"
source_icmp_type Type of the IPv4 ICMP message.
boolean Readonly
Default: "True"
source_transport_port The source transport port of a monitored network flow.
boolean Readonly
Default: "True"
vif_uuid VIF UUID - enterprise specific Information Element that uniquely identifies VIF.
boolean Readonly
Default: "True"

IpfixObsPointConfig (schema) (Deprecated)

Logical IPFIX observation point

IpfixObsPointConfig (i.e. global switch IPFIX config) is deprecated. Please
use IpfixSwitchUpmProfile & IpfixCollectorUpmProfile instead. With them,
switch IPFIX profile can be applied to specific entities, such as logical
switch, logical port and so on.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
active_timeout Active timeout

The time in seconds after a Flow is expired even if more packets
matching this Flow are received by the cache.
int Minimum: 60
Maximum: 3600
Default: "300"
collectors List of IPFIX collectors array of IpfixCollector
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enabled status of IPFIX export boolean Required
id Unique identifier of this resource string Readonly
Sortable
idle_timeout Idle timeout

The time in seconds after a Flow is expired if no more packets matching
this Flow are received by the cache.
int Minimum: 60
Maximum: 3600
Default: "300"
max_flows Max flows

The maximum number of flow entries in each exporter flow cache.
integer Minimum: 0
Maximum: 4294967295
Default: "16384"
observation_domain_id Observation domain ID

An identifier that is unique to the exporting process and used to
meter the Flows.
integer Minimum: 0
Maximum: 4294967295
Default: "0"
packet_sample_probability Packet sample probability

The probability in percentage that a packet is sampled, in range
0-100. The probability is equal for every packet.
number Minimum: 0
Maximum: 100
Default: "0.1"
resource_type Must be set to the value IpfixObsPointConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpfixObsPointsListResult (schema) (Deprecated)

List of logical IPFIX observation points

This is deprecated. Please use UpmProfileListResult instead.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPFIX observation points array of IpfixObsPointConfig
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpfixServiceAssociationListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IpfixConfig list result

Ipfix config list result with pagination support.		 array of IpfixConfig
(Abstract type: pass one of the following concrete types)
IpfixDfwConfig
IpfixSwitchConfig		 Required
Readonly
service_type Must be set to the value IpfixServiceAssociationListResult string Required
Enum: FireWallServiceAssociationListResult, IpfixServiceAssociationListResult
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpfixSwitchConfig (schema) (Deprecated)

IPFIX Config for the Switching Module

This is deprecated. Please use IpfixSwitchUpmProfile instead which can
specify its own collectors and observation ID.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
active_timeout Active timeout

The time in seconds after a Flow is expired even if more packets
matching this Flow are received by the cache.
int Minimum: 60
Maximum: 3600
Default: "300"
applied_tos AppliedTo List

List of objects where the IPFIX Config will be enabled.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
idle_timeout Idle timeout

The time in seconds after a Flow is expired if no more packets matching
this Flow are received by the cache.
int Minimum: 60
Maximum: 3600
Default: "300"
max_flows Max flows

The maximum number of flow entries in each exporter flow cache.
integer Minimum: 0
Maximum: 4294967295
Default: "16384"
packet_sample_probability Packet sample probability

The probability in percentage that a packet is sampled, in range
0-100. The probability is equal for every packet.
number Minimum: 0
Maximum: 100
Default: "0.1"
resource_type Must be set to the value IpfixSwitchConfig IpfixConfigType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpfixSwitchUpmProfile (schema)

Switching IPFIX Profile

The configuration for Internet protocol flow information export (IPFIX) and
would be enabled on the switching module to collect flow information.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
active_timeout Active Timeout

The time in seconds after a flow is expired even if more packets
matching this Flow are received by the cache.
int Minimum: 60
Maximum: 3600
Default: "300"
applied_tos Entitys Applied with Profile

Entities where the IPFIX profile will be enabled on. Maximum
entity count of all types is 128.
AppliedTos
collector_profile UUID of IPFIX Collector Profile

Each IPFIX switching profile can have its own collector profile.
string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
idle_timeout Idle Timeout

The time in seconds after a flow is expired if no more packets matching
this flow are received by the cache.
int Minimum: 60
Maximum: 3600
Default: "300"
max_flows Max Flows

The maximum number of flow entries in each exporter flow cache.
integer Minimum: 0
Maximum: 4294967295
Default: "16384"
observation_domain_id Observation Domain ID

An identifier that is unique to the exporting process and used to
meter the Flows.
integer Required
Minimum: 0
Maximum: 4294967295
packet_sample_probability Packet Sample Probability

The probability in percentage that a packet is sampled, in range
(0,100]. The probability is equal for every packet.
number Minimum: 0
Maximum: 100
Default: "0.1"
priority Profile Priority

This priority field is used to resolve conflicts in logical ports/switch
which inherit multiple switch IPFIX profiles from NSGroups.

Override rule is : for multiple profiles inherited from NSGroups, the
one with highest priority (lowest number) overrides others; the profile
directly applied to logical switch overrides profiles inherited from
NSGroup; the profile directly applied to logical port overides profiles
inherited from logical switch and/or nsgroup;

The IPFIX exporter will send records to collectors of final effective
profile only.
int Required
Minimum: 0
Maximum: 65536
resource_type Must be set to the value IpfixSwitchUpmProfile IpfixUpmProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpfixUpmProfile (schema)

Base IPFIX Profile

Parent profile of all IPFIX profiles. This is an abstract type. Concrete child types:
IpfixSwitchUpmProfile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value IpfixUpmProfile IpfixUpmProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

IpfixUpmProfileListParameters (schema)

IPFIX Profile List Parameters

Query parameters for IPFIX profile list

Name Description Type Notes
applied_to_entity_id ID of Entity Applied with Profile

The entity ID works as a filter param. Entity ID and entity type should
be both provided or not at a query.
string
applied_to_entity_type Type of Entity Applied with Profile

The entity type works as a filter param. Enumerated value in
UpmEntityType could be used here. Entity ID and entity type should be
both provided or not at a query.
UpmEntityType
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
profile_types IPFIX Profile Type List

An English comma-separated list of profile types. Enumerated value in
IpfixUpmProfileType could be listed here as a filter param.
string
sort_ascending boolean
sort_by Field by which records are sorted string

IpfixUpmProfileListResult (schema)

List of IPFIX Profiles

IPFIX profile list result for query with list parameters

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results IPFIX Profile List array of IpfixUpmProfile
(Abstract type: pass one of the following concrete types)
IpfixSwitchUpmProfile		 Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

IpfixUpmProfileType (schema)

IPFIX Profile Types

All IPFIX profile types.

Name Description Type Notes
IpfixUpmProfileType IPFIX Profile Types

All IPFIX profile types.		 string Enum: IpfixSwitchUpmProfile

KeySize (schema)

Crypto key size

Name Description Type Notes
KeySize Crypto key size integer

KeyValue (schema)

Name Description Type Notes
key key name string Required
value key value string Required

KeyValuePair (schema)

An arbitrary key-value pair

Name Description Type Notes
key Key string Required
Maximum length: 255
value Value string Required
Maximum length: 255

KnownHostParameter (schema)

Name Description Type Notes
host Known host hostname or IP address HostnameOrIPv4Address Required
port Known host port integer Minimum: 1
Maximum: 65535
Default: "22"

L2VpnAttachmentContext (schema)

Name Description Type Notes
allocate_addresses A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch. string Enum: IpPool, MacPool, Both, None
resource_type Must be set to the value L2VpnAttachmentContext string Required
tunnel_id Tunnel Id to uniquely identify the extension. int Required

L2VpnService (schema)

L2VPN Service

Defines if service running as hub or spoke Also defines all the common properties for the multiple L2VpnSessions associated with this service.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enable_full_mesh Enable to act as hub

Hub replicates traffic received from peer to all other peers.		 boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id

Logical router id		 string Required
logical_tap_ip_pool IP Pool for Logical Taps

IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical Tap.		 array of IPv4CIDRBlock
resource_type Must be set to the value L2VpnService string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

L2VpnServiceListResult (schema)

List all L2VPN services

Paginated list all the L2VPN services.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results L2VPN serivce list result array of L2VpnService Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

L2VpnSession (schema)

L2VPN Session

Defines the tunnel local and peer addresses along with the multiple tansport tunnels for redundancy. L2VpnSession belongs on to only one L2VpnService.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enable L2VPN session

Enable to extend all the associated logical switches.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
l2vpn_service_id L2VPN service id

L2VPN service id		 string Required
resource_type Must be set to the value L2VpnSession string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_tunnels List of transport tunnels

List of transport tunnels for redundancy.		 array of ResourceReference Required
Minimum items: 1
Maximum items: 1
tunnel_encapsulation Tunnel encapsulation config

Tunnel encapsulation config.		 L2VpnTunnelEncapsulation Readonly

L2VpnSessionListParameters (schema)

L2VPNSession list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
l2vpn_service_id Id of the L2Vpn Service

If provided, only sessions associated with the given L2Vpn service will be returned		 string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

L2VpnSessionListResult (schema)

List all L2VPN sessions

Paginated list all the L2VPN sessions

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results L2VPN sessions list result array of L2VpnSession Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

L2VpnTunnelEncapsulation (schema)

L2VPN tunnel encapsulation config

L2VPN tunnel encapsulation config

Name Description Type Notes
local_endpoint_ip IP Address of the tunnel port

IP Address of the tunnel port. The IP are allocated from L2VpnService logical_tap_ip_pool. All sessions on same L2VpnService get the same local_endpoint_ip.		 IPv4Address
peer_endpoint_ip IP Address of the peer tunnel port

IP Address of the peer tunnel port. The IP are allocated from L2VpnService logical_tap_ip_pool.		 IPv4Address
protocol Encapsulation protocol

Encapsulation protocol used by the tunnel		 string Enum: GRE
Default: "GRE"

L4PortSetNSService (schema)

An NSService element that represents TCP or UDP protocol

L4PortSet can be specified in comma separated notation of parts. Parts of a
L4PortSet includes single integer or range of port in hyphen notation.
Example of a PortSet: "22, 33-70, 44".

Name Description Type Notes
destination_ports Destination ports array of PortElement Maximum items: 15
l4_protocol string Required
Enum: TCP, UDP
resource_type Must be set to the value L4PortSetNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService
source_ports Source ports array of PortElement Maximum items: 15

Label (schema)

Label

Label that will be displayed for a UI element.

Name Description Type Notes
condition Expression for evaluating condition

If the condition is met then the label will be applied. Examples of expression syntax are provided under example_request section of CreateWidgetConfiguration API.		 string Maximum length: 1024
hover Show label only on hover

If true, displays the label only on hover		 boolean Default: "False"
icons Icons

Icons to be applied at dashboard for the label		 array of Icon Minimum items: 0
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details.		 string Maximum length: 1024
text Label text

Text to be displayed at the label.		 string Required
Maximum length: 255

LabelValueConfiguration (schema)

Label Value Dashboard Widget Configuration

Represents a Label-Value widget configuration

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
datasources Array of Datasource Instances with their relative urls

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.		 array of Datasource Minimum items: 0
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
drilldown_id Id of drilldown widget

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.		 string Maximum length: 255
footer Footer
id Unique identifier of this resource string Readonly
Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.		 boolean Default: "False"
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details.		 string Maximum length: 1024
properties Rows

An array of label-value properties.		 array of PropertyItem Required
resource_type Must be set to the value LabelValueConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration
Maximum length: 255
shared Visiblity of widgets to other users

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.		 boolean Deprecated
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.		 int Deprecated

Lag (schema)

LACP group

Name Description Type Notes
id unique id string Readonly
load_balance_algorithm LACP load balance Algorithm string Required
Enum: SRCMAC, DESTMAC, SRCDESTMAC, SRCDESTIPVLAN, SRCDESTMACIPPORT
mode LACP group mode string Required
Enum: ACTIVE, PASSIVE
name Lag name string Required
number_of_uplinks number of uplinks int Required
Minimum: 2
Maximum: 32
timeout_type LACP timeout type string Enum: SLOW, FAST
Default: "SLOW"
uplinks uplink names array of Uplink Readonly
Maximum items: 32

LbActiveMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fall_count num of consecutive checks must fail before marking it down integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Readonly
Sortable
interval the frequency at which the system issues the monitor check (in second) integer Minimum: 1
Maximum: 2147483647
Default: "5"
monitor_port port which is used for healthcheck

If the monitor port is specified, it would override pool member port
setting for healthcheck. A port range is not supported.
PortElement
resource_type Must be set to the value LbActiveMonitor MonitorType Required
rise_count num of consecutive checks must pass before marking it up integer Minimum: 1
Maximum: 2147483647
Default: "3"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout the number of seconds the target has in which to respond to the monitor request integer Minimum: 1
Maximum: 2147483647
Default: "15"

LbAppProfile (schema)

This is an abstract type. Concrete child types:
LbFastTcpProfile
LbFastUdpProfile
LbHttpProfile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value LbAppProfile ApplicationProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbAppProfileListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
type Load balancer application profile type

Specify this type parameter to retrieve a list of load balancer
application profiles of specified type.
ApplicationProfileType

LbAppProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of load balancer application profiles array of LbAppProfile
(Abstract type: pass one of the following concrete types)
LbFastTcpProfile
LbFastUdpProfile
LbHttpProfile		 Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbClientCertificateIssuerDnCondition (schema)

Match condition for client certficate issuer DN

Name Description Type Notes
case_sensitive A case sensitive flag for issuer DN comparing

If true, case is significant when comparing issuer DN value.
boolean Default: "True"
issuer_dn Value of issuer DN string Required
match_type Match type of issuer DN LbRuleMatchType Default: "REGEX"

LbClientCertificateSubjectDnCondition (schema)

Match condition for client certficate subject DN

Name Description Type Notes
case_sensitive A case sensitive flag for subject DN comparing

If true, case is significant when comparing subject DN value.
boolean Default: "True"
match_type Match type of subject DN LbRuleMatchType Default: "REGEX"
subject_dn Value of subject DN string Required

LbClientSslProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
cipher_group_label Label of cipher group

It is a label of cipher group which is mostly consumed by GUI.
SslCipherGroup
ciphers supported SSL cipher list to client side array of SslCipher
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_fips FIPS compliance of ciphers and protocols

This flag is set to true when all the ciphers and protocols are FIPS
compliant. It is set to false when one of the ciphers or protocols are
not FIPS compliant..
boolean Readonly
is_secure Secure/Insecure SSL profile flag

This flag is set to true when all the ciphers and protocols are secure.
It is set to false when one of the ciphers or protocols is insecure.
boolean Readonly
prefer_server_ciphers prefer server ciphers flag

During SSL handshake as part of the SSL client Hello client sends an
ordered list of ciphers that it can support (or prefers) and typically
server selects the first one from the top of that list it can also
support. For Perfect Forward Secrecy(PFS), server could override the
client's preference.
boolean Default: "True"
protocols supported SSL protocol list to client side

SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.
SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
array of SslProtocol
resource_type Must be set to the value LbClientSslProfile string
session_cache_enabled session cache enable/disable flag

SSL session caching allows SSL client and server to reuse previously
negotiated security parameters avoiding the expensive public key
operation during handshake.
boolean Default: "True"
session_cache_timeout SSL session cache timeout value

Session cache timeout specifies how long the SSL session parameters
are held on to and can be reused.
integer Minimum: 1
Maximum: 86400
Default: "300"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbClientSslProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of load balancer client SSL profiles array of LbClientSslProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbCookiePersistenceProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
cookie_domain cookie domain

HTTP cookie domain could be configured, only available for insert mode.
string
cookie_fallback cookie persistence fallback

If fallback is true, once the cookie points to a server that is down
(i.e. admin state DISABLED or healthcheck state is DOWN), then a new
server is selected by default to handle that request.
If fallback is false, it will cause the request to be rejected if
cookie points to a server
boolean Default: "True"
cookie_garble cookie persistence garble

If garble is set to true, cookie value (server IP and port) would be
encrypted.
If garble is set to false, cookie value would be plain text.
boolean Default: "True"
cookie_mode cookie persistence mode CookiePersistenceModeType Default: "INSERT"
cookie_name cookie name string Required
cookie_path cookie path

HTTP cookie path could be set, only available for insert mode.
string
cookie_time cookie time setting

Both session cookie and persistence cookie are supported, if not
specified, it's a session cookie. It expires when the browser is
closed.
LbCookieTime
(Abstract type: pass one of the following concrete types)
LbPersistenceCookieTime
LbSessionCookieTime
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
persistence_shared Persistence shared flag for the associated virtual servers

If persistence shared flag is not set in the cookie persistence profile
bound to a virtual server, it defaults to cookie persistence that is
private to each virtual server and is qualified by the pool. This is
accomplished by load balancer inserting a cookie with name in the
format <name>.<virtual_server_id>.<pool_id>.
If persistence shared flag is set in the cookie persistence profile, in
cookie insert mode, cookie persistence could be shared across multiple
virtual servers that are bound to the same pools. The cookie name would
be changed to <name>.<profile-id>.<pool-id>.
If persistence shared flag is not set in the sourceIp persistence
profile bound to a virtual server, each virtual server that the profile
is bound to maintains its own private persistence table.
If persistence shared flag is set in the sourceIp persistence profile,
all virtual servers the profile is bound to share the same persistence
table.
boolean Default: "False"
resource_type Must be set to the value LbCookiePersistenceProfile PersistenceProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbCookieTime (schema)

This is an abstract type. Concrete child types:
LbPersistenceCookieTime
LbSessionCookieTime

Name Description Type Notes
type CookieTimeType Required

LbFastTcpProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
close_timeout TCP connection idle timeout in seconds

It is used to specify how long a closing TCP connection (both FINs
received or a RST is received) should be kept for this application
before cleaning up the connection.
integer Minimum: 1
Maximum: 60
Default: "8"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
ha_flow_mirroring_enabled flow mirroring enabled flag

If flow mirroring is enabled, all the flows to the bounded virtual
server are mirrored to the standby node.
boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
idle_timeout TCP connection idle timeout in seconds

It is used to configure how long an idle TCP connection in ESTABLISHED
state should be kept for this application before cleaning up.
integer Minimum: 1
Maximum: 2147483647
Default: "1800"
resource_type Must be set to the value LbFastTcpProfile ApplicationProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbFastUdpProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
flow_mirroring_enabled flow mirroring enabled flag

If flow mirroring is enabled, all the flows to the bounded virtual
server are mirrored to the standby node.
boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
idle_timeout UDP idle timeout in seconds

Though UDP is a connectionless protocol, for the purposes of load
balancing, all UDP packets with the same flow signature (source and
destination IP/ports and IP protocol) received within the idle timeout
period are considered to belong to the same connection and are sent to
the same backend server. If no packets are received for idle timeout
period, the connection (association between flow signature and the
selected server) is cleaned up.
integer Minimum: 1
Maximum: 2147483647
Default: "300"
resource_type Must be set to the value LbFastUdpProfile ApplicationProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbHttpMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fall_count num of consecutive checks must fail before marking it down integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Readonly
Sortable
interval the frequency at which the system issues the monitor check (in second) integer Minimum: 1
Maximum: 2147483647
Default: "5"
monitor_port port which is used for healthcheck

If the monitor port is specified, it would override pool member port
setting for healthcheck. A port range is not supported.
PortElement
request_body String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST. string
request_headers Array of HTTP request headers array of LbHttpRequestHeader
request_method the health check method for HTTP monitor type HttpRequestMethodType Default: "GET"
request_url URL used for HTTP monitor string
request_version HTTP request version HttpRequestVersionType Default: "HTTP_VERSION_1_1"
resource_type Must be set to the value LbHttpMonitor MonitorType Required
response_body response body to match

If HTTP response body match string (regular expressions not supported)
is specified (using LbHttpMonitor.response_body) then the
healthcheck HTTP response body is matched against the specified string
and server is considered healthy only if there is a match.
If the response body string is not specified, HTTP healthcheck is
considered successful if the HTTP response status code is 2xx, but it
can be configured to accept other status codes as successful.
string
response_status_codes Array of single HTTP response status codes

The HTTP response status code should be a valid HTTP status code.
array of int Maximum items: 64
rise_count num of consecutive checks must pass before marking it up integer Minimum: 1
Maximum: 2147483647
Default: "3"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout the number of seconds the target has in which to respond to the monitor request integer Minimum: 1
Maximum: 2147483647
Default: "15"

LbHttpProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
http_redirect_to http redirect static URL

If a website is temporarily down or has moved, incoming requests
for that virtual server can be temporarily redirected to a URL
string
http_redirect_to_https flag to indicate whether enable HTTP-HTTPS redirect

Certain secure applications may want to force communication over SSL,
but instead of rejecting non-SSL connections, they may choose to
redirect the client automatically to use SSL.
boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
idle_timeout HTTP application idle timeout in seconds

It is used to specify the HTTP application idle timeout, it means that
how long the load balancer will keep the connection idle to wait for
the client to send the next keep-alive request. It is not a TCP socket
setting.
integer Minimum: 1
Maximum: 2147483647
Default: "15"
ntlm NTLM support flag

NTLM is an authentication protocol that can be used over HTTP. If the
flag is set to true, LB will use NTLM challenge/response methodology.
boolean Default: "False"
request_body_size Maximum size of the buffer used to store HTTP request body

If it is not specified, it means that request body size is unlimited.
integer Minimum: 1
Maximum: 2147483647
request_header_size Maximum size of the buffer used to store HTTP request headers

A request with header larger than request_header_size will be processed
as best effort whereas a request with header below this specified size
is guaranteed to be processed.
integer Minimum: 1
Maximum: 65536
Default: "1024"
resource_type Must be set to the value LbHttpProfile ApplicationProfileType Required
response_timeout Maximum server idle time in seconds

If server doesn't send any packet within this time, the connection is closed.
integer Minimum: 1
Maximum: 2147483647
Default: "60"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
x_forwarded_for insert or replace x_forwarded_for XForwardedForType

LbHttpRedirectAction (schema)

Action to redirect HTTP request messages

This action is used to redirect HTTP request messages to a new URL. The
reply_status value specified in this action is used as the status code of
HTTP response message which is sent back to client (Normally a browser).
The HTTP status code for redirection is 3xx, for example, 301, 302, 303,
307, etc. The redirect_url is the new URL that the HTTP request message is
redirected to. Normally browser will send another HTTP request to the new
URL after receiving a redirection response message.
Captured variables and built-in variables can be used in redirect_url field.
For example, to redirect all HTTP requests to HTTPS requests for a virtual
server. We create an LbRule without any conditions, add an
LbHttpRedirectAction to the rule. Set the
redirect_url field of the LbHttpRedirectAction to:
https://$_host$_request_uri
And set redirect_status to "302", which means found. This rule will
redirect all HTTP requests to HTTPS server port on the same host.

Name Description Type Notes
redirect_status HTTP response status code string Required
redirect_url The URL that the HTTP request is redirected to string Required
type Must be set to the value LbHttpRedirectAction LbRuleActionType Required

LbHttpRejectAction (schema)

Action to reject HTTP request messages

This action is used to reject HTTP request messages. The specified
reply_status value is used as the status code for the corresponding HTTP
response message which is sent back to client (Normally a browser)
indicating the reason it was rejected. Reference official HTTP status code
list for your specific HTTP version to set the reply_status properly.
LbHttpRejectAction does not support variables.

Name Description Type Notes
reply_message Response message string
reply_status HTTP response status code string Required
type Must be set to the value LbHttpRejectAction LbRuleActionType Required

LbHttpRequestBodyCondition (schema)

Condition to match content of HTTP request message body

This condition is used to match the message body of an HTTP request.
Typically, only HTTP POST, PATCH, or PUT requests have request body.
The match_type field defines how body_value field is used to match the body
of HTTP requests.

Name Description Type Notes
body_value HTTP request body string Required
case_sensitive A case sensitive flag for HTTP body comparing

If true, case is significant when comparing HTTP body value.
boolean Default: "True"
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
match_type Match type of HTTP body LbRuleMatchType Default: "REGEX"
type Must be set to the value LbHttpRequestBodyCondition LbRuleConditionType Required

LbHttpRequestCookieCondition (schema)

Condition to match HTTP request cookie

This condition is used to match HTTP request messages by cookie which is a
specific type of HTTP header. The match_type and case_sensitive define how
to compare cookie value.

Name Description Type Notes
case_sensitive A case sensitive flag for cookie value comparing

If true, case is significant when comparing cookie value.
boolean Default: "True"
cookie_name Name of cookie string Required
cookie_value Value of cookie string Required
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
match_type Match type of cookie value LbRuleMatchType Default: "REGEX"
type Must be set to the value LbHttpRequestCookieCondition LbRuleConditionType Required

LbHttpRequestHeader (schema)

Name Description Type Notes
header_name Name of HTTP request header string Required
header_value Value of HTTP request header string Required

LbHttpRequestHeaderCondition (schema)

Condition to match HTTP request header

This condition is used to match HTTP request messages by HTTP header
fields. HTTP header fields are components of the header section of HTTP
request and response messages. They define the operating parameters of an
HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One
condition can be used to match one header field, to match multiple header
fields, multiple conditions must be specified.
The match_type field defines how header_value field is used to match HTTP
requests. The header_name field does not support match types.

Name Description Type Notes
case_sensitive A case sensitive flag for HTTP header value comparing

If true, case is significant when comparing HTTP header value.
boolean Default: "True"
header_name Name of HTTP header string Required
header_value Value of HTTP header string Required
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
match_type Match type of HTTP header value LbRuleMatchType Default: "REGEX"
type Must be set to the value LbHttpRequestHeaderCondition LbRuleConditionType Required

LbHttpRequestHeaderDeleteAction (schema)

Action to delete HTTP request header fields

This action is used to delete header fields of HTTP request messages at
HTTP_REQUEST_REWRITE phase. One action can be used to delete all headers
with same header name. To delete headers with different header names,
multiple actions must be defined.

Name Description Type Notes
header_name Name of a header field of HTTP request message string Required
type Must be set to the value LbHttpRequestHeaderDeleteAction LbRuleActionType Required

LbHttpRequestHeaderRewriteAction (schema)

Action to rewrite header fields of HTTP request messages.

This action is used to rewrite header fields of matched HTTP request
messages to specified new values. One action can be used to rewrite one
header field. To rewrite multiple header fields, multiple actions must be
defined.
Captured variables and built-in variables can be used in the header_value
field, header_name field does not support variables.

Name Description Type Notes
header_name Name of HTTP request header string Required
header_value Value of HTTP request header string Required
type Must be set to the value LbHttpRequestHeaderRewriteAction LbRuleActionType Required

LbHttpRequestMethodCondition (schema)

Condition to match method of HTTP request messages

This condition is used to match method of HTTP requests. If the method of an
HTTP request is same as the method specified in this condition, the HTTP
request match this condition. For example, if the method field is set to
GET in this condition, any HTTP request with GET method matches the
condition.

Name Description Type Notes
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
method Type of HTTP request method HttpRequestMethodType Required
type Must be set to the value LbHttpRequestMethodCondition LbRuleConditionType Required

LbHttpRequestUriArgumentsCondition (schema)

Condition to match URI arguments of HTTP requests

This condition is used to match URI arguments aka query string of Http
request messages, for example, in URI http://exaple.com?foo=1&bar=2, the
"foo=1&bar=2" is the query string containing URI arguments. In an URI
scheme, query string is indicated by the first question mark ("?")
character and terminated by a number sign ("#") character or by the end of
the URI.
The uri_arguments field can be specified as a regular expression(Set
match_type to REGEX). For example, "foo=(?<x>\d+)". It matches HTTP
requests whose URI arguments containing "foo", the value of foo contains
only digits. And the value of foo is captured as $x which can be used in
LbRuleAction fields which support variables.

Name Description Type Notes
case_sensitive A case sensitive flag for URI arguments comparing

If true, case is significant when comparing URI arguments.
boolean Default: "True"
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
match_type Match type of URI arguments LbRuleMatchType Default: "REGEX"
type Must be set to the value LbHttpRequestUriArgumentsCondition LbRuleConditionType Required
uri_arguments URI arguments

URI arguments, aka query string of URI.
string Required

LbHttpRequestUriCondition (schema)

Condition to match URIs of HTTP request messages

This condition is used to match URIs(Uniform Resource Identifier) of HTTP
request messages. The URI field can be specified as a regular expression.
If an HTTP request message is requesting an URI which matches specified
regular expression, it matches the condition.
The syntax of whole URI looks like this:
scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]
This condition matches only the path part of entire URI.
When match_type field is specified as REGEX, the uri field is used as a
regular expression to match URI path of HTTP requests. For example, to
match any URI that has "/image/" or "/images/", uri field can be specified
as: "/image[s]?/".
Named capturing groups can be used in the uri field to capture substrings
of matched URIs and store them in variables for use in LbRuleAction. For
example, specify uri field as:
"/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)"
If the URI path is /articles/news/2017/06/xyz.html, then substring "2017"
is captured in variable year, "06" is captured in variable month, and
"xyz.html" is captured in variable article. These variables can then
be used in an LbRuleAction field which supports variables, such as uri
field of LbHttpRequestUriRewriteAction. For example, set the uri field
of LbHttpRequestUriRewriteAction as:
"/articles/news/$year-$month-$article"
Then the URI path /articles/news/2017/06/xyz.html is rewritten to:
"/articles/news/2017-06-xyz.html"

Name Description Type Notes
case_sensitive A case sensitive flag for URI comparing

If true, case is significant when comparing URI.
boolean Default: "True"
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
match_type Match type of URI LbRuleMatchType Default: "REGEX"
type Must be set to the value LbHttpRequestUriCondition LbRuleConditionType Required
uri A string used to identify resource string Required

LbHttpRequestUriRewriteAction (schema)

Action to rewrite HTTP request URIs.

This action is used to rewrite URIs in matched HTTP request messages.
Specify the uri and uri_arguments fields in this condition to rewrite the
matched HTTP request message's URI and URI arguments to the new values.
Full URI scheme of HTTP messages have following syntax:
scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]
The uri field of this action is used to rewrite the /path part in above
scheme. And the uri_arguments field is used to rewrite the query part.
Captured variables and built-in variables can be used in the uri and
uri_arguments fields.
Check the example in LbRuleAction to see how to use variables in this
action.

Name Description Type Notes
type Must be set to the value LbHttpRequestUriRewriteAction LbRuleActionType Required
uri URI of HTTP request string Required
uri_arguments URI arguments

Query string of URI, typically contains key value pairs, for example:
foo1=bar1&foo2=bar2
string

LbHttpRequestVersionCondition (schema)

Condition to match HTTP protocol version of HTTP requests

This condition is used to match the HTTP protocol version of the HTTP
request messages.

Name Description Type Notes
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
type Must be set to the value LbHttpRequestVersionCondition LbRuleConditionType Required
version HTTP version HttpRequestVersionType Required

LbHttpResponseHeaderCondition (schema)

Condition to match a header field of HTTP response

This condition is used to match HTTP response messages from backend servers
by HTTP header fields. HTTP header fields are components of the header
section of HTTP request and response messages. They define the operating
parameters of an HTTP transaction. For example, Cookie, Authorization,
User-Agent, etc. One condition can be used to match one header field, to
match multiple header fields, multiple conditions must be specified.
The match_type field defines how header_value field is used to match HTTP
responses. The header_name field does not support match types.

Name Description Type Notes
case_sensitive A case sensitive flag for HTTP header value comparing

If true, case is significant when comparing HTTP header value.
boolean Default: "True"
header_name Name of HTTP header field string Required
header_value Value of HTTP header field string Required
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
match_type Match type of HTTP header value LbRuleMatchType Default: "REGEX"
type Must be set to the value LbHttpResponseHeaderCondition LbRuleConditionType Required

LbHttpResponseHeaderDeleteAction (schema)

Action to delete HTTP response header fields

This action is used to delete header fields of HTTP response messages at
HTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers
with same header name. To delete headers with different header names,
multiple actions must be defined

Name Description Type Notes
header_name Name of a header field of HTTP response message string Required
type Must be set to the value LbHttpResponseHeaderDeleteAction LbRuleActionType Required

LbHttpResponseHeaderRewriteAction (schema)

Action to rewrite HTTP response header fields

This action is used to rewrite header fields of HTTP response messages to
specified new values at HTTP_RESPONSE_REWRITE phase. One action can be used
to rewrite one header field. To rewrite multiple header fields, multiple
actions must be defined.
Captured variables and built-in variables can be used in the header_value
field, header_name field does not support variables.

Name Description Type Notes
header_name Name of a header field of HTTP request message string Required
header_value Value of header field string Required
type Must be set to the value LbHttpResponseHeaderRewriteAction LbRuleActionType Required

LbHttpSslCondition (schema)

Condition to match SSL handshake and SSL connection

This condition is used to match SSL handshake and SSL connection at
all phases.If multiple properties are configured, the rule is considered
a match when all the configured properties are matched.

Name Description Type Notes
client_certificate_issuer_dn The issuer DN match condition of the client certificate

The issuer DN match condition of the client certificate for an
established SSL connection
LbClientCertificateIssuerDnCondition
client_certificate_subject_dn The subject DN match condition of the client certificate

The subject DN match condition of the client certificate for an
established SSL connection
LbClientCertificateSubjectDnCondition
client_supported_ssl_ciphers Cipher list which supported by client array of SslCipher
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
session_reused The type of SSL session reused LbSslSessionReusedType Default: "IGNORE"
type Must be set to the value LbHttpSslCondition LbRuleConditionType Required
used_protocol Protocol of an established SSL connection SslProtocol
used_ssl_cipher Cipher used for an established SSL connection SslCipher

LbHttpsMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
certificate_chain_depth the maximum traversal depth of server certificate chain

authentication depth is used to set the verification depth in the server
certificates chain.
integer Minimum: 1
Maximum: 2147483647
Default: "3"
cipher_group_label Label of cipher group

It is a label of cipher group which is mostly consumed by GUI.
SslCipherGroup
ciphers supported SSL cipher list to servers array of SslCipher
client_certificate_id client certificate identifier

client certificate can be specified to support client authentication.
string
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fall_count num of consecutive checks must fail before marking it down integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Readonly
Sortable
interval the frequency at which the system issues the monitor check (in second) integer Minimum: 1
Maximum: 2147483647
Default: "5"
is_fips FIPS compliance of ciphers and protocols

This flag is set to true when all the ciphers and protocols are FIPS
compliant. It is set to false when one of the ciphers or protocols are
not FIPS compliant..
boolean Readonly
is_secure Secure/Insecure monitor flag

This flag is set to true when all the ciphers and protocols are secure.
It is set to false when one of the ciphers or protocols is insecure.
boolean Readonly
monitor_port port which is used for healthcheck

If the monitor port is specified, it would override pool member port
setting for healthcheck. A port range is not supported.
PortElement
protocols supported SSL protocol list to servers

SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.
SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
array of SslProtocol
request_body String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST. string
request_headers Array of HTTP request headers array of LbHttpRequestHeader
request_method the health check method for HTTP monitor type HttpRequestMethodType Default: "GET"
request_url URL used for HTTP monitor string
request_version HTTP request version HttpRequestVersionType Default: "HTTP_VERSION_1_1"
resource_type Must be set to the value LbHttpsMonitor MonitorType Required
response_body response body to match

If HTTP response body match string (regular expressions not supported)
is specified (using LbHttpMonitor.response_body) then the
healthcheck HTTP response body is matched against the specified string
and server is considered healthy only if there is a match.
If the response body string is not specified, HTTP healthcheck is
considered successful if the HTTP response status code is 2xx, but it
can be configured to accept other status codes as successful.
string
response_status_codes Array of single HTTP response status codes

The HTTP response status code should be a valid HTTP status code.
array of int Maximum items: 64
rise_count num of consecutive checks must pass before marking it up integer Minimum: 1
Maximum: 2147483647
Default: "3"
server_auth server authentication mode ServerAuthType Default: "IGNORE"
server_auth_ca_ids CA identifier list to verify server certificate

If server auth type is REQUIRED, server certificate must be signed by
one of the trusted Certificate Authorities (CAs), also referred to as
root CAs, whose self signed certificates are specified.
array of string
server_auth_crl_ids CRL identifier list to verify server certificate

A Certificate Revocation List (CRL) can be specified in the server-side
SSL profile binding to disallow compromised server certificates.
array of string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout the number of seconds the target has in which to respond to the monitor request integer Minimum: 1
Maximum: 2147483647
Default: "15"

LbIcmpMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
data_length The data size(in byte) of the ICMP healthcheck packet integer Minimum: 0
Maximum: 65507
Default: "56"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fall_count num of consecutive checks must fail before marking it down integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Readonly
Sortable
interval the frequency at which the system issues the monitor check (in second) integer Minimum: 1
Maximum: 2147483647
Default: "5"
monitor_port port which is used for healthcheck

If the monitor port is specified, it would override pool member port
setting for healthcheck. A port range is not supported.
PortElement
resource_type Must be set to the value LbIcmpMonitor MonitorType Required
rise_count num of consecutive checks must pass before marking it up integer Minimum: 1
Maximum: 2147483647
Default: "3"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout the number of seconds the target has in which to respond to the monitor request integer Minimum: 1
Maximum: 2147483647
Default: "15"

LbIpHeaderCondition (schema)

Condition to match IP header fields

This condition is used to match IP header fields of HTTP messages.
Currently, only the source IP address is supported. IP addresses can be
expressed as a single IP address like 10.1.1.1, or a range of IP addresses
like 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.

Name Description Type Notes
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
source_address Source IP address of HTTP message IPElement Required
type Must be set to the value LbIpHeaderCondition LbRuleConditionType Required

LbLogLevel (schema)

the log level of load balancer service

Name Description Type Notes
LbLogLevel the log level of load balancer service string Enum: DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY

LbMonitor (schema)

This is an abstract type. Concrete child types:
LbHttpMonitor
LbHttpsMonitor
LbIcmpMonitor
LbPassiveMonitor
LbTcpMonitor
LbUdpMonitor

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value LbMonitor MonitorType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbMonitorListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
type Load balancer monitor type

Specify this type parameter to retrieve a list of load balancer
monitors of specified type.
MonitorQueryType

LbMonitorListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of load balancer monitors array of LbMonitor
(Abstract type: pass one of the following concrete types)
LbHttpMonitor
LbHttpsMonitor
LbIcmpMonitor
LbPassiveMonitor
LbTcpMonitor
LbUdpMonitor		 Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbPassiveMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
max_fails number of consecutive connection failures

When the consecutive failures reach this value, then the member is
considered temporarily unavailable for a configurable period
integer Minimum: 1
Maximum: 2147483647
Default: "5"
resource_type Must be set to the value LbPassiveMonitor MonitorType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout timeout in seconds before it is selected again for a new connection

After this timeout period, the member is tried again for a new
connection to see if it is available.
integer Minimum: 1
Maximum: 2147483647
Default: "5"

LbPersistenceCookieTime (schema)

Name Description Type Notes
cookie_max_idle persistence cookie max idle time in seconds

HTTP cookie max-age to expire cookie, only available for insert mode.
integer Required
Minimum: 1
Maximum: 2147483647
type Must be set to the value LbPersistenceCookieTime CookieTimeType Required

LbPersistenceProfile (schema)

This is an abstract type. Concrete child types:
LbCookiePersistenceProfile
LbSourceIpPersistenceProfile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
persistence_shared Persistence shared flag for the associated virtual servers

If persistence shared flag is not set in the cookie persistence profile
bound to a virtual server, it defaults to cookie persistence that is
private to each virtual server and is qualified by the pool. This is
accomplished by load balancer inserting a cookie with name in the
format <name>.<virtual_server_id>.<pool_id>.
If persistence shared flag is set in the cookie persistence profile, in
cookie insert mode, cookie persistence could be shared across multiple
virtual servers that are bound to the same pools. The cookie name would
be changed to <name>.<profile-id>.<pool-id>.
If persistence shared flag is not set in the sourceIp persistence
profile bound to a virtual server, each virtual server that the profile
is bound to maintains its own private persistence table.
If persistence shared flag is set in the sourceIp persistence profile,
all virtual servers the profile is bound to share the same persistence
table.
boolean Default: "False"
resource_type Must be set to the value LbPersistenceProfile PersistenceProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbPersistenceProfileListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
type Load balancer persistence profile type

Specify this type parameter to retrieve a list of load balancer
persistence profiles of specified type.
PersistenceProfileType

LbPersistenceProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of load balancer persistence profiles array of LbPersistenceProfile
(Abstract type: pass one of the following concrete types)
LbCookiePersistenceProfile
LbSourceIpPersistenceProfile		 Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbPool (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
active_monitor_ids active monitor identifier list

In case of active healthchecks, load balancer itself initiates new
connections (or sends ICMP ping) to the servers periodically to check
their health, completely independent of any data traffic. Active
healthchecks are disabled by default and can be enabled for a server
pool by binding a health monitor to the pool. Currently, only one active
health monitor can be configured per server pool.
array of string
algorithm pool balancing algorithm for backend pool members

Load balancing algorithm, configurable per pool controls how the
incoming connections are distributed among the members.
PoolAlgorithm Default: "ROUND_ROBIN"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
member_group Load balancer member setting with grouping object

Load balancer pool support grouping object as dynamic pool members.
When member group is defined, members setting should not be specified.
PoolMemberGroup
members load balancer pool members

Server pool consists of one or more pool members. Each pool member
is identified, typically, by an IP address and a port.
array of PoolMember
min_active_members minimum number of active pool members to consider pool as active

A pool is considered active if there are at least certain
minimum number of members.
integer Minimum: 1
Maximum: 2147483647
Default: "1"
passive_monitor_id passive monitor identifier

Passive healthchecks are disabled by default and can be enabled by
attaching a passive health monitor to a server pool.
Each time a client connection to a pool member fails, its failed count
is incremented. For pools bound to L7 virtual servers, a connection is
considered to be failed and failed count is incremented if any TCP
connection errors (e.g. TCP RST or failure to send data) or SSL
handshake failures occur. For pools bound to L4 virtual servers, if no
response is received to a TCP SYN sent to the pool member or if a TCP
RST is received in response to a TCP SYN, then the pool member is
considered to have failed and the failed count is incremented.
string
resource_type Must be set to the value LbPool string
snat_translation snat translation configuration

Depending on the topology, Source NAT (SNAT) may be required to ensure
traffic from the server destined to the client is received by the load
balancer. SNAT can be enabled per pool. If SNAT is not enabled for a
pool, then load balancer uses the client IP and port (spoofing) while
establishing connections to the servers. This is referred to as no-SNAT
or TRANSPARENT mode.
LbSnatTranslation
(Abstract type: pass one of the following concrete types)
LbSnatAutoMap
LbSnatIpPool
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tcp_multiplexing_enabled TCP multiplexing enable flag

TCP multiplexing allows the same TCP connection between load balancer
and the backend server to be used for sending multiple client requests
from different client TCP connections.
boolean Default: "False"
tcp_multiplexing_number maximum number of TCP connections for multiplexing

The maximum number of TCP connections per pool that are idly kept alive
for sending future client requests.
integer Minimum: 0
Maximum: 2147483647
Default: "6"

LbPoolListRequestParameters (schema)

Name Description Type Notes
active_monitor_id Active monitor id specified to filter corresponding pools string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
passive_monitor_id Passive monitor id specified to filter corresponding pools string
sort_ascending boolean
sort_by Field by which records are sorted string

LbPoolListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of pools array of LbPool Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbPoolMemberStatistics (schema)

Name Description Type Notes
ip_address Pool member IP address IPAddress Required
port Pool member port

The port is configured in pool member. For virtual server port range
case, pool member port must be null.
PortElement
statistics Pool member statistics counter LbStatisticsCounter Required

LbPoolMemberStatus (schema)

Name Description Type Notes
failure_cause The healthcheck failure cause when status is DOWN string
ip_address Pool member IP address IPAddress Required
last_check_time EpochMsTimestamp
last_state_change_time EpochMsTimestamp
port Pool member port

The port is configured in pool member. For virtual server port range
case, pool member port must be null.
PortElement
status Pool member status

UP means that pool member is enabled and monitors have marked the pool
member as UP. If the pool member has no monitor configured, it would
be treated as UP.
DOWN means that pool member is enabled and monitors have marked the
pool member as DOWN.
DISABLED means that admin state of pool member is set to DISABLED.
GRACEFUL_DISABLED means that admin state of pool member is set to
GRACEFUL_DISABLED.
UNUSED means that the pool member is not used when the IP list size
of member group exceeds the maximum setting. The remaining IP addresses
would not be used as available backend servers, hence mark the status
as UNUSED.
string Required
Enum: UP, DOWN, DISABLED, GRACEFUL_DISABLED, UNUSED

LbPoolStatistics (schema)

Name Description Type Notes
last_update_timestamp Timestamp when the data was last updated EpochMsTimestamp
members Statistics of load balancer pool members array of LbPoolMemberStatistics
pool_id Load balancer pool identifier string Required
statistics Virtual server statistics counter LbStatisticsCounter Required

LbPoolStatisticsListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated statistics list of pools array of LbPoolStatistics Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbPoolStatus (schema)

Name Description Type Notes
last_update_timestamp Timestamp when the data was last updated EpochMsTimestamp
members Status of load balancer pool members array of LbPoolMemberStatus
pool_id Load balancer pool identifier string Required
status Virtual server status

UP means that all primary members are in UP status.
PARTIALLY_UP means that some(not all) primary members are in UP
status, the number of these active members is larger or equal to
certain number(min_active_members) which is defined in LbPool.
When there are no backup members which are in the UP status, the
number(min_active_members) would be ignored.
PRIMARY_DOWN means that less than certain(min_active_members) primary
members are in UP status but backup members are in UP status,
connections to this pool would be dispatched to backup members.
DOWN means that all primary and backup members are DOWN.
DETACHED means that the pool is not bound to any virtual server.
UNKOWN means that no status reported from transport-nodes. The
associated load balancer service may be working(or not working).
string Enum: UP, PARTIALLY_UP, PRIMARY_DOWN, DOWN, DETACHED, UNKNOWN

LbPoolStatusListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated status list of pools array of LbPoolStatus Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbRule (schema)

Load balancer rules

Load balancer rules allow customization of load balancing behavior using
match/action rules. Currently, load balancer rules are supported for only
layer 7 virtual servers with application profile LbHttpProfile.
Each application rule consists of one or more match conditions and one or
more actions.
Load balancer rules could be used by different load balancer services.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
actions Actions to be executed

A list of actions to be executed at specified phase when load balancer
rule matches. The actions are used to manipulate application traffic,
such as rewrite URI of HTTP messages, redirect HTTP messages, etc.
array of LbRuleAction
(Abstract type: pass one of the following concrete types)
LbHttpRedirectAction
LbHttpRejectAction
LbHttpRequestHeaderDeleteAction
LbHttpRequestHeaderRewriteAction
LbHttpRequestUriRewriteAction
LbHttpResponseHeaderDeleteAction
LbHttpResponseHeaderRewriteAction
LbSelectPoolAction
LbVariableAssignmentAction		 Required
Maximum items: 60
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
match_conditions Conditions to match application traffic

A list of match conditions used to match application traffic. Multiple
match conditions can be specified in one load balancer rule, each match
condition defines a criterion to match application traffic.
If no match conditions are specified, then the load balancer rule will
always match and it is used typically to define default rules. If more
than one match condition is specified, then match strategy determines
if all conditions should match or any one condition should match for the
load balancer rule to considered a match.
array of LbRuleCondition
(Abstract type: pass one of the following concrete types)
LbHttpRequestBodyCondition
LbHttpRequestCookieCondition
LbHttpRequestHeaderCondition
LbHttpRequestMethodCondition
LbHttpRequestUriArgumentsCondition
LbHttpRequestUriCondition
LbHttpRequestVersionCondition
LbHttpResponseHeaderCondition
LbHttpSslCondition
LbIpHeaderCondition
LbTcpHeaderCondition
LbVariableCondition		 Maximum items: 60
match_strategy Strategy to match multiple conditions

Strategy to define how load balancer rule is considered a match when
multiple match conditions are specified in one rule. If match_stragety
is set to ALL, then load balancer rule is considered a match only if all
the conditions match. If match_strategy is set to ANY, then load
balancer rule is considered a match if any one of the conditions match.
string Required
Enum: ALL, ANY
phase Load balancer processing phase

Each load balancer rule is used at a specific phase of load balancer
processing. Currently three phases are supported, HTTP_REQUEST_REWRITE,
HTTP_FORWARDING and HTTP_RESPONSE_REWRITE.
When an HTTP request message is received by load balancer, all
HTTP_REQUEST_REWRITE rules, if present are executed in the order they
are applied to virtual server. And then if HTTP_FORWARDING rules
present, only first matching rule's action is executed, remaining rules
are not checked. HTTP_FORWARDING rules can have only one action. If the
request is forwarded to a backend server and the response goes back to
load balancer, all HTTP_RESPONSE_REWRITE rules, if present, are executed
in the order they are applied to the virtual server.
string Required
Enum: HTTP_REQUEST_REWRITE, HTTP_FORWARDING, HTTP_RESPONSE_REWRITE
resource_type Must be set to the value LbRule string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbRuleAction (schema)

Load balancer rule action

Load balancer rule actions are used to manipulate application traffic.
Currently load balancer rules can be used at three load balancer processing
phases. Each phase has its own supported type of actions.
Supported actions in HTTP_REQUST_REWRITE phase are:
LbHttpRequestUriRewriteAction
LbHttpRequestHeaderRewriteAction
LbHttpRequestHeaderDeleteAction
LbVariableAssignmentAction
Supported actions in HTTP_FORWARDING phase are:
LbHttpRejectAction
LbHttpRedirectAction
LbSelectPoolAction
Supported action in HTTP_RESPONSE_REWRITE phase is:
LbHttpResponseHeaderRewriteAction
LbHttpResponseHeaderDeleteAction

If the match type of an LbRuleCondition field is specified as REGEX and
named capturing groups are used in the specified regular expression. The
groups can be used as variables in LbRuleAction fields.
For example, define a rule with LbHttpRequestUriCondition as match
condition and LbHttpRequestUriRewriteAction as action. Set match_type field
of LbHttpRequestUriCondition to REGEX, and set uri field to
"/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)".
Set uri field of LbHttpRequestUriRewriteAction to:
"/news/$year-$month/$article"
In uri field of LbHttpRequestUriCondition, the (?<year>\d+),
(?<month>\d+) and (?<article>.*) are named capturing groups,
they define variables named $year, $month and $article respectively. The
defined variables are used in LbHttpRequestUriRewriteAction.
For a matched HTTP request with URI "/news/2017/06/xyz.html", the substring
"2017" is captured in variable $year, "06" is captured in variable $month,
and "xyz.html" is captured in variable $article. The
LbHttpRequestUriRewriteAction will rewrite the URI to:
"/news/2017-06/xyz.html"
A set of built-in variables can be used in LbRuleAction as well. The name
of built-in variables start with underscore, the name of user defined
variables is not allowed to start with underscore.
Following are some of the built-in variables:
$_scheme: Reference the scheme part of matched HTTP messages, could be
"http" or "https".
$_host: Host of matched HTTP messages, for example "www.example.com".
$_server_port: Port part of URI, it is also the port of the server which
accepted a request. Default port is 80 for http and 443 for https.
$_uri: The URI path, for example "/products/sample.html".
$_request_uri: Full original request URI with arguments, for example,
"/products/sample.html?a=b&c=d".
$_args: URI arguments, for instance "a=b&c=d"
$_is_args: "?" if a request has URI arguments, or an empty string
otherwise.
For the full list of built-in variables, please reference the NSX-T
Administrator's Guide.
This is an abstract type. Concrete child types:
LbHttpRedirectAction
LbHttpRejectAction
LbHttpRequestHeaderDeleteAction
LbHttpRequestHeaderRewriteAction
LbHttpRequestUriRewriteAction
LbHttpResponseHeaderDeleteAction
LbHttpResponseHeaderRewriteAction
LbSelectPoolAction
LbVariableAssignmentAction

Name Description Type Notes
type Type of load balancer rule action LbRuleActionType Required

LbRuleActionType (schema)

Types of load balancer rule actions

Name Description Type Notes
LbRuleActionType Types of load balancer rule actions string Enum: LbHttpRequestUriRewriteAction, LbHttpRequestHeaderRewriteAction, LbHttpRejectAction, LbHttpRedirectAction, LbSelectPoolAction, LbSelectServerAction, LbHttpResponseHeaderRewriteAction, LbHttpRequestHeaderDeleteAction, LbHttpResponseHeaderDeleteAction, LbVariableAssignmentAction

LbRuleCondition (schema)

Match condition of load balancer rule

Match conditions are used to match application traffic passing through
load balancers. Multiple match conditions can be specified in one load
balancer rule, each match condition defines a criterion for application
traffic.
If inverse field is set to true, the match result of the condition is
inverted.
If more than one match condition is specified, match strategy determines
if all conditions should match or any one condition should match for the
load balancer rule to be considered a match.
Currently only HTTP messages are supported by load balancer rules.
Each load balancer rule is used at a specific phase of load balancer
processing. Currently three phases are supported, HTTP_REQUEST_REWRITE,
HTTP_FORWARDING and HTTP_RESPONSE_REWRITE.
Each phase supports certain types of match conditions, supported match
conditions in HTTP_REQUEST_REWRITE phase are:
LbHttpRequestMethodCondition
LbHttpRequestUriCondition
LbHttpRequestUriArgumentsCondition
LbHttpRequestVersionCondition
LbHttpRequestHeaderCondition
LbHttpRequestCookieCondition
LbHttpRequestBodyCondition
LbTcpHeaderCondition
LbIpHeaderCondition
LbVariableCondition
LbHttpSslCondition
Supported match conditions in HTTP_FORWARDING phase are:
LbHttpRequestMethodCondition
LbHttpRequestUriCondition
LbHttpRequestVersionCondition
LbHttpRequestHeaderCondition
LbHttpRequestCookieCondition
LbHttpRequestBodyCondition
LbTcpHeaderCondition
LbIpHeaderCondition
LbVariableCondition
LbHttpSslCondition
Supported match condition in HTTP_RESPONSE_REWRITE phase is:
LbHttpResponseHeaderCondition
LbHttpRequestMethodCondition
LbHttpRequestUriCondition
LbHttpRequestUriArgumentsCondition
LbHttpRequestVersionCondition
LbHttpRequestHeaderCondition
LbHttpRequestCookieCondition
LbTcpHeaderCondition
LbIpHeaderCondition
LbVariableCondition
LbHttpSslCondition
This is an abstract type. Concrete child types:
LbHttpRequestBodyCondition
LbHttpRequestCookieCondition
LbHttpRequestHeaderCondition
LbHttpRequestMethodCondition
LbHttpRequestUriArgumentsCondition
LbHttpRequestUriCondition
LbHttpRequestVersionCondition
LbHttpResponseHeaderCondition
LbHttpSslCondition
LbIpHeaderCondition
LbTcpHeaderCondition
LbVariableCondition

Name Description Type Notes
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
type Type of load balancer rule condition LbRuleConditionType Required

LbRuleConditionType (schema)

Type of load balancer rule match condition

Name Description Type Notes
LbRuleConditionType Type of load balancer rule match condition string Enum: LbHttpRequestMethodCondition, LbHttpRequestUriCondition, LbHttpRequestUriArgumentsCondition, LbHttpRequestVersionCondition, LbHttpRequestHeaderCondition, LbHttpRequestCookieCondition, LbHttpRequestBodyCondition, LbHttpResponseHeaderCondition, LbTcpHeaderCondition, LbIpHeaderCondition, LbVariableCondition, LbHttpSslCondition

LbRuleListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of LB rules array of LbRule Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbRuleMatchType (schema)

Match type for LbRule conditions

LbRuleMatchType is used to determine how a specified string value is used
to match a specified LbRuleCondition field.
STARTS_WITH: If the LbRuleCondition field starts with specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
ENDS_WITH: If the LbRuleCondition field ends with specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
EQUALS: If the LbRuleCondition field is same as the specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
CONTAINS: If the LbRuleCondition field contains the specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
REGEX: If the LbRuleCondition field matches specified regular expression,
the condition matches. The regular expressions in load balancer rules use
the features common to both Java regular expressions and Perl Compatible
Regular Expressions (PCREs) with some restrictions. Reference
http://www.pcre.org for PCRE and the NSX-T Administrator's Guide for the
restrictions.
If named capturing groups are used in the regular expression, when a
match succeeds, the substrings of the subject string that match named
capturing groups are stored (captured) in variables with specific names
which can be used in the fields of LbRuleAction which support variables.
Named capturing group are defined in the format (?<name>subpattern),
such as (?<year>\d{4}).
For example, in the regular expression:
"/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)", for
subject string "/news/2017/06/xyz.html", the substring "2017" is captured
in variable year, "06" is captured in variable month, and "xyz.html" is
captured in variable article. These variables can be used in LbRuleAction
fields which support variables in form of $name, such as $year, $month,
$article.
Please note, when regular expressions are used in JSON(JavaScript Object
Notation) string, every backslash character (\) needs to be escaped by one
additional backslash character.

Name Description Type Notes
LbRuleMatchType Match type for LbRule conditions

LbRuleMatchType is used to determine how a specified string value is used
to match a specified LbRuleCondition field.
STARTS_WITH: If the LbRuleCondition field starts with specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
ENDS_WITH: If the LbRuleCondition field ends with specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
EQUALS: If the LbRuleCondition field is same as the specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
CONTAINS: If the LbRuleCondition field contains the specified string, the
condition matches. The fields with this match type are specified as
strings, not regular expressions.
REGEX: If the LbRuleCondition field matches specified regular expression,
the condition matches. The regular expressions in load balancer rules use
the features common to both Java regular expressions and Perl Compatible
Regular Expressions (PCREs) with some restrictions. Reference
http://www.pcre.org for PCRE and the NSX-T Administrator's Guide for the
restrictions.
If named capturing groups are used in the regular expression, when a
match succeeds, the substrings of the subject string that match named
capturing groups are stored (captured) in variables with specific names
which can be used in the fields of LbRuleAction which support variables.
Named capturing group are defined in the format (?<name>subpattern),
such as (?<year>\d{4}).
For example, in the regular expression:
"/news/(?<year>\d+)/(?<month>\d+)/(?<article>.*)", for
subject string "/news/2017/06/xyz.html", the substring "2017" is captured
in variable year, "06" is captured in variable month, and "xyz.html" is
captured in variable article. These variables can be used in LbRuleAction
fields which support variables in form of $name, such as $year, $month,
$article.
Please note, when regular expressions are used in JSON(JavaScript Object
Notation) string, every backslash character (\) needs to be escaped by one
additional backslash character.
string Enum: STARTS_WITH, ENDS_WITH, EQUALS, CONTAINS, REGEX

LbSelectPoolAction (schema)

Action to select a pool for HTTP request messages

This action is used to select a pool for matched HTTP request messages. The
pool is specified by UUID. The matched HTTP request messages are forwarded
to the specified pool.

Name Description Type Notes
pool_id UUID of load balancer pool string Required
type Must be set to the value LbSelectPoolAction LbRuleActionType Required

LbServerSslProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
cipher_group_label Label of cipher group

It is a label of cipher group which is mostly consumed by GUI.
SslCipherGroup
ciphers supported SSL cipher list to client side array of SslCipher
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_fips FIPS compliance of ciphers and protocols

This flag is set to true when all the ciphers and protocols are FIPS
compliant.
It is set to false when one of the ciphers or protocols are not
FIPS compliant.
boolean Readonly
is_secure Secure/Insecure SSL profile flag

This flag is set to true when all the ciphers and protocols are secure.
It is set to false when one of the ciphers or protocols is insecure.
boolean Readonly
protocols supported SSL protocol list to client side

SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.
SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
array of SslProtocol
resource_type Must be set to the value LbServerSslProfile string
session_cache_enabled session cache enable/disable falg

SSL session caching allows SSL client and server to reuse previously
negotiated security parameters avoiding the expensive public key
operation during handshake.
boolean Default: "True"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbServerSslProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of load balancer server SSL profiles array of LbServerSslProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbService (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
access_log_enabled whether access log is enabled boolean Deprecated
Default: "False"
attachment The target which is used to instantiate Lb service.

LBS could be instantiated (or created) on the Logical router, etc.
Typically, it could be applied to Tier1 LogicalRouter. It can be
attached to Tier0 LogicalRouter either in non-multi-tenant environments
or to provide load balancing for infrastructure services offered by
the provider.
ResourceReference
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled whether the load balancer service is enabled boolean Default: "True"
error_log_level Error log level of load balancer service

Load balancer engine writes information about encountered issues of
different severity levels to the error log. This setting is used to
define the severity level of the error log.
LbLogLevel Default: "INFO"
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value LbService string
size the size of load balancer service LbServiceSize Default: "SMALL"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
virtual_server_ids virtual server identifier list

virtual servers can be associated to LbService(which is
similar to physical/virtual load balancer), Lb virtual servers,
pools and other entities could be defined independently, the virtual
server identifier list here would be used to maintain the relationship of
LbService and other Lb entities.
array of string

LbServiceListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
virtual_server_id Virtual server identifier string

LbServiceListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of load balancer services array of LbService Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbServiceQueryRequestParameters (schema)

Load balancer service list request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
logical_router_id Logical router identifier

When logical_router_id is specified, the list load balancer API will
return the load balancer services which are related to the given
logical router.
string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

LbServiceSize (schema)

the size of load balancer service

To address varied customer performance and scalability requirements,
different sizes for load balancer service are supported:
LARGE, MEDIUM and SMALL, each with its own set of resource and performance
specifications.

Name Description Type Notes
LbServiceSize the size of load balancer service

To address varied customer performance and scalability requirements,
different sizes for load balancer service are supported:
LARGE, MEDIUM and SMALL, each with its own set of resource and performance
specifications.
string Enum: SMALL, MEDIUM, LARGE

LbSessionCookieTime (schema)

Name Description Type Notes
cookie_max_idle session cookie max idle time in seconds

Instead of using HTTP Cookie max-age and relying on client to expire
the cookie, max idle time and/or max lifetime of the cookie can be used.
Max idle time, if configured, specifies the maximum interval the cookie
is valid for from the last time it was seen in a request.
It is available for insert mode.
integer Minimum: 1
Maximum: 2147483647
cookie_max_life session cookie max lifetime in seconds

Max life time, if configured, specifies the maximum interval the cookie
is valid for from the first time the cookie was seen in a request.
It is available for insert mode.
integer Minimum: 1
Maximum: 2147483647
type Must be set to the value LbSessionCookieTime CookieTimeType Required

LbSnatAutoMap (schema)

Name Description Type Notes
port_overload port overloading with same SNAT IP and port

Both SNAT automap and SNAT IP list modes support port overloading
which allows the same SNAT IP and port to be used for multiple
backend connections as long as the tuple (source IP, source port,
destination IP, destination port, IP protocol) after SNAT is
performed is unique.
The valid number is 1, 2, 4, 8, 16, 32.
integer Minimum: 1
Maximum: 32
Default: "32"
type Must be set to the value LbSnatAutoMap SnatTranslationType Required

LbSnatIpElement (schema)

Name Description Type Notes
ip_address Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160 IPElement Required
prefix_length subnet prefix length

Subnet prefix length should be not specified if there is only one single
IP address or IP range.
integer

LbSnatIpPool (schema)

Name Description Type Notes
ip_addresses List of Ip address or ip range

If an IP range is specified, the range may contain no more than 64
IP addresses.
array of LbSnatIpElement Required
Maximum items: 64
port_overload port overloading with same SNAT IP and port

Both SNAT automap and SNAT IP list modes support port overloading
which allows the same SNAT IP and port to be used for multiple
backend connections as long as the tuple (source IP, source port,
destination IP, destination port, IP protocol) after SNAT is
performed is unique.
The valid number is 1, 2, 4, 8, 16, 32.
integer Minimum: 1
Maximum: 32
Default: "32"
type Must be set to the value LbSnatIpPool SnatTranslationType Required

LbSnatTranslation (schema)

This is an abstract type. Concrete child types:
LbSnatAutoMap
LbSnatIpPool

Name Description Type Notes
port_overload port overloading with same SNAT IP and port

Both SNAT automap and SNAT IP list modes support port overloading
which allows the same SNAT IP and port to be used for multiple
backend connections as long as the tuple (source IP, source port,
destination IP, destination port, IP protocol) after SNAT is
performed is unique.
The valid number is 1, 2, 4, 8, 16, 32.
integer Minimum: 1
Maximum: 32
Default: "32"
type SnatTranslationType Required

LbSourceIpPersistenceProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
ha_persistence_mirroring_enabled mirroring enabled flag to synchronize persistence entries

Persistence entries are not synchronized to the HA peer by default.
boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
persistence_shared Persistence shared flag for the associated virtual servers

If persistence shared flag is not set in the cookie persistence profile
bound to a virtual server, it defaults to cookie persistence that is
private to each virtual server and is qualified by the pool. This is
accomplished by load balancer inserting a cookie with name in the
format <name>.<virtual_server_id>.<pool_id>.
If persistence shared flag is set in the cookie persistence profile, in
cookie insert mode, cookie persistence could be shared across multiple
virtual servers that are bound to the same pools. The cookie name would
be changed to <name>.<profile-id>.<pool-id>.
If persistence shared flag is not set in the sourceIp persistence
profile bound to a virtual server, each virtual server that the profile
is bound to maintains its own private persistence table.
If persistence shared flag is set in the sourceIp persistence profile,
all virtual servers the profile is bound to share the same persistence
table.
boolean Default: "False"
purge persistence purge setting SourceIpPersistencePurge Default: "FULL"
resource_type Must be set to the value LbSourceIpPersistenceProfile PersistenceProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout persistence entry expiration time in seconds

When all connections complete (reference count reaches 0), persistence
entry timer is started with the expiration time.
integer Minimum: 1
Maximum: 2147483647
Default: "300"

LbSslCipherAndProtocolListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
ciphers List of SSL ciphers array of LbSslCipherInfo Required
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
protocols List of SSL protocols array of LbSslProtocolInfo Required
result_count Count of results found (across all pages), set only on first page integer Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbSslCipherInfo (schema)

SSL cipher

Name Description Type Notes
cipher SSL cipher SslCipher Required
cipher_group_labels Cipher group label list

Several cipher groups might contain the same cipher suite, each cipher
suite could have multiple cipher group labels.
array of SslCipherGroup
is_default Default SSL cipher flag boolean Required
is_secure Secure/insecure SSL cipher flag boolean Required

LbSslProfile (schema)

Load balancer abstract SSL profile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value LbSslProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbSslProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of load balancer SSL profiles array of LbSslProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbSslProtocolInfo (schema)

SSL protocol

Name Description Type Notes
is_default Default SSL protocol flag boolean Required
is_secure Secure/insecure SSL protocol flag boolean Required
protocol SSL protocol SslProtocol Required

LbSslSessionReusedType (schema)

Type of SSL session reused

Name Description Type Notes
LbSslSessionReusedType Type of SSL session reused string Enum: IGNORE, REUSED, NEW

LbStatisticsCounter (schema)

Name Description Type Notes
bytes_in Number of bytes in integer Required
bytes_in_rate The average number of inbound bytes per second, the number is averaged over the last 5 one-second intervals. number
bytes_out Number of bytes out integer Required
bytes_out_rate The average number of outbound bytes per second, the number is averaged over the last 5 one-second intervals. number
current_session_rate The average number of current sessions per second, the number is averaged over the last 5 one-second intervals. number
current_sessions Number of current sessions integer Required
http_request_rate The average number of http requests per second, the number is averaged over the last 5 one-second intervals. number
http_requests The total number of http requests. integer
max_sessions Number of maximum sessions integer Required
packets_in Number of packets in integer
packets_in_rate The average number of inbound packets per second, the number is averaged over the last 5 one-second intervals. number
packets_out Number of packets out integer
packets_out_rate The average number of outbound packets per second, the number is averaged over the last 5 one-second intervals. number
source_ip_persistence_entry_size Number of source IP persistence entries integer
total_sessions Number of total sessions integer Required

LbTcpHeaderCondition (schema)

Condition to match TCP header fields

This condition is used to match TCP header fields of HTTP messages.
Currently, only the TCP source port is supported. Ports can be expressed as
a single port number like 80, or a port range like 1024-1030.

Name Description Type Notes
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
source_port TCP source port of HTTP message PortElement Required
type Must be set to the value LbTcpHeaderCondition LbRuleConditionType Required

LbTcpMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fall_count num of consecutive checks must fail before marking it down integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Readonly
Sortable
interval the frequency at which the system issues the monitor check (in second) integer Minimum: 1
Maximum: 2147483647
Default: "5"
monitor_port port which is used for healthcheck

If the monitor port is specified, it would override pool member port
setting for healthcheck. A port range is not supported.
PortElement
receive expected data received from server

Expected data, if specified, can be anywhere in the response and it has to
be a string, regular expressions are not supported.
string
resource_type Must be set to the value LbTcpMonitor MonitorType Required
rise_count num of consecutive checks must pass before marking it up integer Minimum: 1
Maximum: 2147483647
Default: "3"
send data to send

If both send and receive are not specified, then just a TCP connection
is established (3-way handshake) to validate server is healthy, no
data is sent.
string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout the number of seconds the target has in which to respond to the monitor request integer Minimum: 1
Maximum: 2147483647
Default: "15"

LbTcpProfile (schema)

TCP profile allows customization of TCP stack behavior.

TCP profile allows customization of TCP stack behavior for each
application. As TCP connections are terminated (or initiated) on the load
balancer only for L7 virtual servers, TCP profiles are applicable only to
them. As the desired TCP characteristics (e.g. Rx/Tx buffers) may be
different for client (typically on WAN) and server (typically on LAN)
sides, two separate profiles can be bound to virtual server, one for
client-side (LbVirtualServer.client_tcp_profile_id) and another for
server-side (LbVirtualServer.server_tcp_profile_id).

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fin_wait2_timeout Sets how long TCP connections in FIN_WAIT2 state are kept.

If the field is not specified, the load balancer will use the default
setting per load balancer service flavor.
integer Minimum: 0
Maximum: 2147483647
id Unique identifier of this resource string Readonly
Sortable
max_syn_retransmissions Sets the max number of times TCP SYN is retransmitted before failing an attempt to connect.

If the field is not specified, the load balancer will use the default
setting per load balancer service flavor.
integer Minimum: 1
Maximum: 127
nagle_algorithm_enabled Setting this option to enable or disable Nagle's algorithm. boolean Default: "True"
receive_window_size Sets max TCP receive buffer, specified in bytes.

If the field is not specified, the load balancer will use the default
setting per load balancer service flavor.
integer Minimum: 1024
Maximum: 2147483647
resource_type Must be set to the value LbTcpProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transmit_window_size Sets max TCP transmit buffer, specified in bytes.

If the field is not specified, the load balancer will use the default
setting per load balancer service flavor.
integer Minimum: 2048
Maximum: 2147483647

LbTcpProfileListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paginated list of load balancer TCP profiles array of LbTcpProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbUdpMonitor (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fall_count num of consecutive checks must fail before marking it down integer Minimum: 1
Maximum: 2147483647
Default: "3"
id Unique identifier of this resource string Readonly
Sortable
interval the frequency at which the system issues the monitor check (in second) integer Minimum: 1
Maximum: 2147483647
Default: "5"
monitor_port port which is used for healthcheck

If the monitor port is specified, it would override pool member port
setting for healthcheck. A port range is not supported.
PortElement
receive expected data received from server

Expected data, can be anywhere in the response and it has to be a
string, regular expressions are not supported.
UDP healthcheck is considered failed if there is no server response
within the timeout period.
string Required
resource_type Must be set to the value LbUdpMonitor MonitorType Required
rise_count num of consecutive checks must pass before marking it up integer Minimum: 1
Maximum: 2147483647
Default: "3"
send data to send

The data to be sent to the monitored server.
string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
timeout the number of seconds the target has in which to respond to the monitor request integer Minimum: 1
Maximum: 2147483647
Default: "15"

LbVariableAssignmentAction (schema)

Action to create variable and assign value to it.

This action is used to create a new variable and assign value to it.
One action can be used to create one variable. To create multiple
variables, multiple actions must be defined.
The variables can be used by LbVariableCondition, etc.

Name Description Type Notes
type Must be set to the value LbVariableAssignmentAction LbRuleActionType Required
variable_name Name of the variable to be assigned string Required
variable_value Value of variable string Required

LbVariableCondition (schema)

Condition to match IP header fields

This condition is used to match variable's name and value at all
phases. The variables could be captured from REGEX or assigned by
LbVariableAssignmentAction or system embedded variable. Varialbe_name
and variable_value should be matched at the same time.

Name Description Type Notes
case_sensitive A case sensitive flag for variable value comparing

If true, case is significant when comparing variable value.
boolean Default: "True"
inverse A flag to indicate whether reverse the match result of this condition boolean Default: "False"
match_type Match type of variable value LbRuleMatchType Default: "REGEX"
type Must be set to the value LbVariableCondition LbRuleConditionType Required
variable_name Name of the variable to be matched string Required
variable_value Value of variable to be matched string Required

LbVirtualServer (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
access_log_enabled Whether access log is enabled boolean Default: "False"
application_profile_id application profile identifier

The application profile defines the application protocol characteristics.
It is used to influence how load balancing is performed. Currently,
LbFastTCPProfile, LbFastUDPProfile and
LbHttpProfile, etc are supported.
string Required
client_ssl_profile_binding Virtual server side SSL binding setting

The setting is used when load balancer acts as an SSL server and
terminating the client SSL connection
ClientSslProfileBinding
client_tcp_profile_id Identifier of client side TCP profile

Only L7 virtual server could be configured with customized client
side TCP profile.
string
default_pool_member_port Default pool member port when member port is not defined.

This is a deprecated property, please use 'default_pool_member_ports'
instead.
If default_pool_member_port is configured and default_pool_member_ports
are not specified, both default_pool_member_port
and default_pool_member_ports in response payload would return the same
port value.
If both are specified, default_pool_member_ports setting would take
effect with higher priority.
PortElement Deprecated
default_pool_member_ports Default pool member ports when member port is not defined.

If default_pool_member_ports are configured, both
default_pool_member_port and default_pool_member_ports in the response
payload would include port settings, notice that the value of
default_pool_member_port is the first element of
default_pool_member_ports.
array of PortElement Maximum items: 14
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled whether the virtual server is enabled boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
ip_address virtual server IP address IPAddress Required
ip_protocol virtual server IP protocol

Assigned Internet Protocol in IP header, TCP, UDP are supported.
VirtualServerIpProtocol Default: "TCP"
max_concurrent_connections maximum concurrent connection number

To ensure one virtual server does not over consume resources,
affecting other applications hosted on the same LBS, connections
to a virtual server can be capped.
If it is not specified, it means that connections are unlimited.
integer Minimum: 1
Maximum: 2147483647
max_new_connection_rate maximum new connection rate in second

To ensure one virtual server does not over consume resources,
connections to a member can be rate limited.
If it is not specified, it means that connection rate is unlimited.
integer Minimum: 1
Maximum: 2147483647
persistence_profile_id persistence profile identifier

Persistence profile is used to allow related client connections to be
sent to the same backend server.
string
pool_id default server pool identifier

The server pool(LbPool) contains backend servers. Server pool
consists of one or more servers, also referred to as pool members, that
are similarly configured and are running the same application.
string
port Virtual server port number or port range

This is a deprecated property, please use 'ports' instead.
Port setting could be single port for both L7 mode and L4 mode.
For L4 mode, a single port range is also supported.
The port setting could be a single port or port range such as
"80", "1234-1236".
If port is configured and ports are not specified, both port and
ports in response payload would return the same port value.
If both port and ports are configured, ports setting would take effect
with higher priority.
PortElement Deprecated
ports Virtual server ports or port ranges

Port setting could be a single port for both L7 mode and L4 mode.
For L4 mode, multiple ports or port ranges are also supported such
as "80", "443", "1234-1236".
If ports is configured, both port and ports in the response payload
would include port settings, notice that the port field value is the
first element of ports.
array of PortElement Maximum items: 14
resource_type Must be set to the value LbVirtualServer string
rule_ids List of load balancer rule identifiers

Load balancer rules allow customization of load balancing behavior using
match/action rules. Currently, load balancer rules are supported for
only layer 7 virtual servers with LbHttpProfile.
array of string Maximum items: 512
server_ssl_profile_binding Pool side SSL binding setting

The setting is used when load balancer acts as an SSL client and
establishing a connection to the backend server.
ServerSslProfileBinding
server_tcp_profile_id Identifier of server side TCP profile

Only L7 virtual server could be configured with customized server
side TCP profile.
string
sorry_pool_id Identifier of sorry server pool

When load balancer can not select a backend server to serve the
request in default pool or pool in rules, the request would be served
by sorry server pool.
string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LbVirtualServerListRequestParameters (schema)

Name Description Type Notes
application_profile_id Application profile id specified to filter corresponding virtual servers

Specify application profile id to filter corresponding virtual server.
Return virtual servers which are associdated with this application
profile.
string
client_ssl_profile_id Client ssl profile id specified to filter corresponding virtual servers

Specify client ssl profile id to filter corresponding virtual server.
Return virtual servers which are associdated with this client ssl
profile.
string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
persistence_profile_id Persistence profile id specified to filter corresponding virtual servers

Specify persistence profile id to filter corresponding virtual server.
Return virtual servers which are associdated with this persistence
profile.
string
pool_id Pool id specified to filter corresponding virtual servers

Specify pool id to filter corresponding virtual server. Return virtual
servers which are associdated with this pool.
string
server_ssl_profile_id Server ssl profile id specified to filter corresponding virtual servers

Specify server ssl profile id to filter corresponding virtual server.
Return virtual servers which are associdated with this server ssl
profile.
string
service_id Lbs id specified to filter corresponding virtual servers

Specify lb service id to filter corresponding virtual server. Return
virtual servers which are associdated with this lbs.
string
sort_ascending boolean
sort_by Field by which records are sorted string

LbVirtualServerListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of virtual servers array of LbVirtualServer Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbVirtualServerStatistics (schema)

Name Description Type Notes
last_update_timestamp Timestamp when the data was last updated EpochMsTimestamp
statistics Virtual server statistics counter LbStatisticsCounter Required
virtual_server_id load balancer virtual server identifier string Required

LbVirtualServerStatisticsListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated statistics list of virtual servers array of LbVirtualServerStatistics Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LbVirtualServerStatus (schema)

Name Description Type Notes
last_update_timestamp Timestamp when the data was last updated. EpochMsTimestamp
status Virtual server status

UP means that all primary members in default pool are in UP status.
For L7 virtual server, if there is no default pool, the virtual server
would be treated as UP.
PARTIALLY_UP means that some(not all) primary members in default pool
are in UP status. The size of these active primary members should be
larger than or equal to the certain number(min_active_members) which is
defined in LbPool. When there are no backup members which are in the UP
status, the number(min_active_members) would be ignored.
PRIMARY_DOWN means that less than certain(min_active_members) primary
members in default pool are in UP status but backup members are in UP
status, the connections would be dispatched to backup members.
DOWN means that all primary and backup members are in DOWN status.
DETACHED means that the virtual server is not bound to any service.
DISABLED means that the admin state of the virtual server is disabled.
UNKOWN means that no status reported from transport-nodes. The
associated load balancer service may be working(or not working).
string Enum: UP, PARTIALLY_UP, PRIMARY_DOWN, DOWN, DETACHED, DISABLED, UNKNOWN
virtual_server_id load balancer virtual server identifier string Required

LbVirtualServerStatusListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated status list of virtual servers array of LbVirtualServerStatus Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

License (schema)

license properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
capacity_type license metric string Readonly
Enum: VM, CPU, USER
description license edition string Readonly
expiry date that license expires EpochMsTimestamp Readonly
features semicolon delimited feature list string Readonly
is_eval true for evalution license boolean Readonly
is_expired whether the license has expired boolean Readonly
is_mh multi-hypervisor support boolean Readonly
license_key license key string Required
Pattern: "^[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}$"
product_name product name string Readonly
product_version product version string Readonly
quantity license capacity; 0 for unlimited integer Readonly

LicensesListResult (schema)

Licenses queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Licenses Results array of License Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ListByNodeIdParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string

ListByOptionalNodeIdParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id Transport node id string

ListByRequiredNodeIdParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string Required

ListCertParameter (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
details whether to expand the pem data and show all its details boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
type Type of certificate to return

Provide this parameter to limit the list of returned certificates to those matching a particular usage.
Passing cluster_certificate will return the certificate used for the cluster wide API service.
string Enum: cluster_api_certificate

ListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

ListResult (schema)

Base class for list results from collections

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ListResultQueryParameters (schema)

Parameters that affect how list results are processed

Name Description Type Notes
fields Fields to include in query results

Comma-separated field names to include in query result		 string

ListWithDataSourceParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType

LldpHostSwitchProfile (schema)

Host Switch for LLDP

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value LldpHostSwitchProfile HostSwitchProfileType Required
send_enabled Enabled or disabled sending LLDP packets boolean Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LoadBalancerAllocationPool (schema)

Name Description Type Notes
allocation_pool_type Must be set to the value LoadBalancerAllocationPool AllocationPoolType Required
allocation_size Size of load balancer service

To address varied customer performance and scalability requirements,
different sizes for load balancer service are supported: SMALL, MEDIUM
and LARGE, each with its own set of resource and performance. Specify
size of load balancer service which you will bind to TIER1 router.
string Required
Enum: SMALL, MEDIUM, LARGE
Default: "SMALL"

LogicalDhcpServer (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
attached_logical_port_id id of attached logical port string Readonly
description Description of this resource string Maximum length: 1024
Sortable
dhcp_profile_id dhcp profile uuid string Required
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
ipv4_dhcp_server dhcp server for ipv4 addresses IPv4DhcpServer Required
resource_type Must be set to the value LogicalDhcpServer string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalDhcpServerListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of dhcp servers array of LogicalDhcpServer Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalPort (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
address_bindings Address bindings for logical port array of PacketAddressClassifier Minimum items: 0
Maximum items: 512
admin_state Represents Desired state of the logical port string Required
Enum: UP, DOWN
attachment Logical port attachment LogicalPortAttachment
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
extra_configs Extra configs on logical port

This property could be used for vendor specific configuration in key value
string pairs. Logical port setting will override logical switch setting if
the same key was set on both logical switch and logical port.
array of ExtraConfig
id Unique identifier of this resource string Readonly
Sortable
init_state Initial state of this logical ports

Set initial state when a new logical port is created. 'UNBLOCKED_VLAN'
means new port will be unblocked on traffic in creation, also VLAN will
be set with corresponding logical switch setting.
LogicalPortInitState
logical_switch_id Id of the Logical switch that this port belongs to. string Required
resource_type Must be set to the value LogicalPort string
switching_profile_ids array of SwitchingProfileTypeIdEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalPortAttachment (schema)

Logical port attachment

Name Description Type Notes
attachment_type Type of attachment for logical port

Indicates the type of logical port attachment. By default it is Virtual Machine interface (VIF)		 AttachmentType Default: "VIF"
context Attachment context

Extra context data for the attachment		 AttachmentContext
(Abstract type: pass one of the following concrete types)
L2VpnAttachmentContext
VifAttachmentContext
id Identifier of the interface attached to the logical port string Required

LogicalPortInitState (schema)

Supported initial state of logical port

Name Description Type Notes
LogicalPortInitState Supported initial state of logical port string Enum: UNBLOCKED_VLAN

LogicalPortListParameters (schema)

Logical port list parameters

Name Description Type Notes
attachment_id Logical Port attachment Id string
attachment_type Type of attachment for logical port; NONE means no attachment. AttachmentTypeQueryString
bridge_cluster_id Bridge Cluster identifier string
container_ports_only Only container VIF logical ports will be returned if true boolean Default: "False"
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
diagnostic Flag to enable showing of transit logical port. boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
logical_switch_id Logical Switch identifier string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
parent_vif_id ID of the VIF of type PARENT

Get logical ports that have CHILD VIF attachment of given
PARENT VIF.
string
sort_ascending boolean
sort_by Field by which records are sorted string
switching_profile_id Network Profile identifier string
transport_node_id Transport node identifier

Get logical ports on the transport node; it can not be given
together with other parameters except container_ports_only and
attachment_type VIF.
string
transport_zone_id Transport zone identifier string

LogicalPortListResult (schema)

Logical port queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results LogicalPort Results array of LogicalPort Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalPortListWithSourceParameters (schema)

Logical Port list with data source parameters

Name Description Type Notes
attachment_id Logical Port attachment Id string
attachment_type Type of attachment for logical port; NONE means no attachment. AttachmentTypeQueryString
bridge_cluster_id Bridge Cluster identifier string
container_ports_only Only container VIF logical ports will be returned if true boolean Default: "False"
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
diagnostic Flag to enable showing of transit logical port. boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
logical_switch_id Logical Switch identifier string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
parent_vif_id ID of the VIF of type PARENT

Get logical ports that have CHILD VIF attachment of given
PARENT VIF.
string
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
switching_profile_id Network Profile identifier string
transport_node_id Transport node identifier

Get logical ports on the transport node; it can not be given
together with other parameters except container_ports_only and
attachment_type VIF.
string
transport_zone_id Transport zone identifier string

LogicalPortMacAddressCsvListResult (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
results array of LogicalPortMacTableCsvEntry

LogicalPortMacAddressListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
logical_port_id The id of the logical port string Required
Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results array of LogicalPortMacTableEntry
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly
transport_node_id Transport node identifier string Readonly

LogicalPortMacTableCsvEntry (schema)

Name Description Type Notes
mac_address The MAC address string Required
mac_type The type of the MAC address MacAddressType Required

LogicalPortMacTableEntry (schema)

Name Description Type Notes
mac_address The MAC address string Required
mac_type The type of the MAC address MacAddressType Required

LogicalPortMirrorDestination (schema)

Name Description Type Notes
port_ids Destination logical port identifier list. array of string Required
Minimum items: 1
Maximum items: 3
resource_type Must be set to the value LogicalPortMirrorDestination MirrorDestinationResourceType Required

LogicalPortMirrorSource (schema)

Name Description Type Notes
port_ids Source logical port identifier list array of string Required
resource_type Must be set to the value LogicalPortMirrorSource MirrorSourceResourceType Required

LogicalRouter (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
advanced_config Logical Router Configuration

Contains config properties for tier0 routers		 LogicalRouterConfig
allocation_profile Edge Cluster Member Allocation Profile

Configurations options to auto allocate edge cluster members for
logical router. Auto allocation is supported only for TIER1 and pick
least utilized member post current assignment for next allocation.
EdgeClusterMemberAllocationProfile
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
edge_cluster_id Identifier of the edge cluster for this Logical Router

Used for tier0 routers		 string
edge_cluster_member_indices Member indices of the edge node on the cluster

For stateful services, the logical router should be associated with
edge cluster. For TIER 1 logical router, for manual placement of
service router within the cluster, edge cluster member indices needs
to be provided else same will be auto-allocated. You can provide
maximum two indices for HA ACTIVE_STANDBY. For TIER0 logical router
this property is no use and placement is derived from logical router
uplink or loopback port.
array of integer
failover_mode Failover mode for active-standby logical router instances.

Determines the behavior when a logical router instance restarts after
a failure. If set to PREEMPTIVE, the preferred node will take over,
even if it causes another failure. If set to NON_PREEMPTIVE, then the
instance that restarted will remain secondary.
This property must not be populated unless the high_availability_mode property
is set to ACTIVE_STANDBY.
If high_availability_mode property is set to ACTIVE_STANDBY and this property
is not specified then default will be NON_PREEMPTIVE.
string Enum: PREEMPTIVE, NON_PREEMPTIVE
firewall_sections LR Firewall Section References

List of Firewall sections related to Logical Router.		 array of ResourceReference Readonly
high_availability_mode High availability mode string Enum: ACTIVE_ACTIVE, ACTIVE_STANDBY
id Unique identifier of this resource string Readonly
Sortable
preferred_edge_cluster_member_index Preferred edge cluster member index in active standby mode for pre-emptive failover

Used for tier0 routers only		 integer Minimum: 0
resource_type Must be set to the value LogicalRouter string
router_type Type of Logical Router string Required
Enum: TIER0, TIER1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalRouterCentralizedServicePort (schema)

Port to connect VLAN based network or overlay logical switch

This port can be configured on both TIER0 and TIER1 logical router.
Port can be connected to VLAN or overlay logical switch.
Unlike downlink port it does not participate in distributed routing and
hosted on all edge cluster members associated with logical router.
Stateful services can be applied on this port.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enable_netx Port is exclusively used for N-S service insertion boolean Default: "False"
id Unique identifier of this resource string Readonly
Sortable
linked_logical_switch_port_id Reference to the logical switch port to connect to ResourceReference
logical_router_id Identifier for logical router on which this port is created string Required
resource_type Must be set to the value LogicalRouterCentralizedServicePort LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
subnets Logical router port subnets array of IPSubnet Required
Minimum items: 1
Maximum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
urpf_mode Unicast Reverse Path Forwarding mode UrpfMode Default: "STRICT"

LogicalRouterConfig (schema)

Name Description Type Notes
external_transit_networks CIDR block defining tier0 to tier1 links array of IPv4CIDRBlock
ha_vip_configs Array of HA VIP Config.

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.		 array of HaVipConfig
internal_transit_network CIDR block defining Service router to distributed router links IPv4CIDRBlock
transport_zone_id Transport Zone Identifier

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.		 string

LogicalRouterDownLinkPort (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
linked_logical_switch_port_id Reference to the logical switch port to connect to ResourceReference
logical_router_id Identifier for logical router on which this port is created string Required
mac_address MAC address

MAC address		 string Readonly
resource_type Must be set to the value LogicalRouterDownLinkPort LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
subnets Logical router port subnets array of IPSubnet Required
Minimum items: 1
Maximum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
urpf_mode Unicast Reverse Path Forwarding mode UrpfMode Default: "STRICT"

LogicalRouterFIBListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
network_prefix CIDR network address to filter the RIB and FIB table. IPv4CIDRBlock
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string Required

LogicalRouterFIBRequestParameters (schema)

Name Description Type Notes
network_prefix CIDR network address to filter the the RIB and FIB table. IPv4CIDRBlock
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string Required

LogicalRouterIPTunnelPort (schema)

Logical router IP tunnel port

Logical router IP tunnel port.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
admin_state Admin state of port

Admin state of port.		 string Readonly
Enum: UP, DOWN
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Identifier for logical router on which this port is created string Required
resource_type Must be set to the value LogicalRouterIPTunnelPort LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
subnets Tunnel port subnets

Tunnel port subnets.		 array of IPSubnet Required
Readonly
Minimum items: 1
Maximum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vpn_session_id VPN session identifier

Associated VPN session identifier.		 string Readonly

LogicalRouterLinkPortOnTIER0 (schema)

Port to connect the LogicalRouterLinkPortOnTIER1 of TIER1 logical router to

This port can be configured only on a TIER0 LogicalRouter.
Create an empty port to generate an id.
Use this id in the linked_logical_router_port_id on
LogicalRouterLinkPortOnTIER1 on TIER1 logical router.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
linked_logical_router_port_id Identifier of connected LogicalRouterLinkPortOnTIER1

Identifier of connected LogicalRouterLinkPortOnTIER1 of TIER1 logical router		 string Readonly
logical_router_id Identifier for logical router on which this port is created string Required
mac_address MAC address

MAC address		 string Readonly
resource_type Must be set to the value LogicalRouterLinkPortOnTIER0 LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
subnets Logical router port subnets array of IPSubnet Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalRouterLinkPortOnTIER1 (schema)

Port to connect the TIER1 logical router to TIER0 logical router

This port can be configured only on a TIER1 LogicalRouter.
Use the id of the LogicalRouterLinkPortOnTIER0 from TIER0 logical router to set
the linked_logical_router_port_id on the port on TIER1 logical router.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
edge_cluster_member_index Member index of the edge node on the cluster

Please use logical router API to pass edge cluster members indexes manually.
array of integer Deprecated
id Unique identifier of this resource string Readonly
Sortable
linked_logical_router_port_id Reference of TIER0 port to connect the TIER1 to.

Reference of LogicalRouterLinkPortOnTIER0 of TIER0 logical router to connect this TIER1 logical router outwards.
ResourceReference
logical_router_id Identifier for logical router on which this port is created string Required
mac_address MAC address

MAC address		 string Readonly
resource_type Must be set to the value LogicalRouterLinkPortOnTIER1 LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
subnets Logical router port subnets array of IPSubnet Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalRouterListParameters (schema)

Logical Router list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
router_type Type of Logical Router string Enum: TIER0, TIER1
sort_ascending boolean
sort_by Field by which records are sorted string

LogicalRouterListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Logical router list results array of LogicalRouter Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalRouterLoopbackPort (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
edge_cluster_member_index Member index of the edge node on the cluster array of integer Required
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Identifier for logical router on which this port is created string Required
resource_type Must be set to the value LogicalRouterLoopbackPort LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
subnets Loopback port subnets array of IPSubnet Required
Minimum items: 1
Maximum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalRouterPort (schema)

This is an abstract type. Concrete child types:
LogicalRouterCentralizedServicePort
LogicalRouterDownLinkPort
LogicalRouterLinkPortOnTIER0
LogicalRouterLinkPortOnTIER1
LogicalRouterLoopbackPort
LogicalRouterUpLinkPort

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Identifier for logical router on which this port is created string Required
resource_type Must be set to the value LogicalRouterPort LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalRouterPortArpCsvRecord (schema)

Name Description Type Notes
ip The IP address IPAddress Required
mac_address The MAC address string Required

LogicalRouterPortArpEntry (schema)

Name Description Type Notes
ip The IP address IPAddress Required
mac_address The MAC address string Required

LogicalRouterPortArpTable (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
logical_router_port_id The ID of the logical router port string Required
result_count Count of results found (across all pages), set only on first page integer Readonly
results array of LogicalRouterPortArpEntry
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalRouterPortArpTableInCsvFormat (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
results array of LogicalRouterPortArpCsvRecord

LogicalRouterPortListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Logical router port list results array of LogicalRouterPort
(Abstract type: pass one of the following concrete types)
LogicalRouterCentralizedServicePort
LogicalRouterDownLinkPort
LogicalRouterLinkPortOnTIER0
LogicalRouterLinkPortOnTIER1
LogicalRouterLoopbackPort
LogicalRouterUpLinkPort		 Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalRouterPortResourceType (schema)

Resource types of logical router port

LogicalRouterUpLinkPort is allowed only on TIER0 logical router.
It is the north facing port of the logical router.
LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router.
This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to.
LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router.
This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router.
Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router.
LogicalRouterDownLinkPort is for the connected subnets on the logical router.
LogicalRouterLoopbackPort is a loopback port for logical router component
which is placed on chosen edge cluster member.
LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on
logical router when route based VPN session configured.
LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1
logical router. Port can be connected to VLAN or overlay logical switch.
Unlike downlink port it does not participate in distributed routing and hosted
on all edge cluster members associated with logical router.
Stateful services can be applied on this port.

Name Description Type Notes
LogicalRouterPortResourceType Resource types of logical router port

LogicalRouterUpLinkPort is allowed only on TIER0 logical router.
It is the north facing port of the logical router.
LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router.
This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to.
LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router.
This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router.
Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router.
LogicalRouterDownLinkPort is for the connected subnets on the logical router.
LogicalRouterLoopbackPort is a loopback port for logical router component
which is placed on chosen edge cluster member.
LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on
logical router when route based VPN session configured.
LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1
logical router. Port can be connected to VLAN or overlay logical switch.
Unlike downlink port it does not participate in distributed routing and hosted
on all edge cluster members associated with logical router.
Stateful services can be applied on this port.
string Enum: LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPortOnTIER0, LogicalRouterLinkPortOnTIER1, LogicalRouterLoopbackPort, LogicalRouterIPTunnelPort, LogicalRouterCentralizedServicePort

LogicalRouterPortsListParameters (schema)

Logical Router Ports list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
logical_router_id Logical Router identifier string
logical_switch_id Logical Switch identifier string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_type Resource Type LogicalRouterPortResourceType
sort_ascending boolean
sort_by Field by which records are sorted string

LogicalRouterRIBListRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
network_prefix CIDR network address to filter the RIB and FIB table. IPv4CIDRBlock
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
route_source To filter the RIB table based on the source from which route is learned. string Enum: BGP, STATIC, CONNECTED
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string Required

LogicalRouterRIBRequestParameters (schema)

Name Description Type Notes
network_prefix CIDR network address to filter the the RIB and FIB table. IPv4CIDRBlock
route_source To filter the RIB table based on the source from which route is learned. string Enum: BGP, STATIC, CONNECTED
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string Required

LogicalRouterRouteCsvRecord (schema)

Name Description Type Notes
admin_distance The admin distance of the next hop integer
logical_router_port_id The id of the logical router port which is used as the next hop string
lr_component_id Logical router component(Service Router/Distributed Router) id string
lr_component_type Logical router component(Service Router/Distributed Router) type string
network CIDR network address IPv4CIDRBlock Required
next_hop The IP of the next hop IPAddress
route_type Route type (USER, CONNECTED, NSX_INTERNAL,..) string Required

LogicalRouterRouteEntry (schema)

Name Description Type Notes
admin_distance The admin distance of the next hop integer
logical_router_port_id The id of the logical router port which is used as the next hop string
lr_component_id Logical router component(Service Router/Distributed Router) id string
lr_component_type Logical router component(Service Router/Distributed Router) type string
network CIDR network address IPv4CIDRBlock Required
next_hop The IP address of the next hop IPAddress
route_type Route type (USER, CONNECTED, NSX_INTERNAL,..) string Required

LogicalRouterRouteTable (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
logical_router_id The id of the logical router string Required
logical_router_name Name of the logical router string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results array of LogicalRouterRouteEntry
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalRouterRouteTableInCsvFormat (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
results array of LogicalRouterRouteCsvRecord

LogicalRouterUpLinkPort (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
edge_cluster_member_index Member index of the edge node on the cluster array of integer Required
id Unique identifier of this resource string Readonly
Sortable
linked_logical_switch_port_id Reference to the logical switch port to connect to ResourceReference
logical_router_id Identifier for logical router on which this port is created string Required
mac_address MAC address

MAC address		 string Readonly
mtu Maximum transmission unit (MTU)

Maximum transmission unit specifies the size of the largest packet that a network protocol can transmit.		 integer Minimum: 64
Maximum: 9000
Default: "1500"
resource_type Must be set to the value LogicalRouterUpLinkPort LogicalRouterPortResourceType Required
service_bindings Service Bindings array of ServiceBinding
subnets Logical router port subnets array of IPSubnet Required
Minimum items: 1
Maximum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
urpf_mode Unicast Reverse Path Forwarding mode UrpfMode Default: "STRICT"

LogicalService (schema) (Deprecated)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
dhcp_relay_profile_id dhcp relay profile referenced by the dhcp relay service string Required
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value LogicalService LogicalServiceResourceTypes Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

LogicalServiceListResult (schema) (Deprecated)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Logical router service list results array of LogicalService Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalServiceResourceTypes (schema) (Deprecated)

Resource types of logical services

Name Description Type Notes
LogicalServiceResourceTypes Resource types of logical services string Deprecated
Enum: DhcpRelayService

LogicalSwitch (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
address_bindings Address bindings for the Logical switch array of PacketAddressClassifier Minimum items: 0
Maximum items: 100
admin_state Represents Desired state of the Logical Switch string Required
Enum: UP, DOWN
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
extra_configs Extra configs on logical switch

This property could be used for vendor specific configuration in key value
string pairs, the setting in extra_configs will be automatically inheritted
by logical ports in the logical switch.
array of ExtraConfig
id Unique identifier of this resource string Readonly
Sortable
ip_pool_id Allocation ip pool associated with the Logical switch

IP pool id that associated with a LogicalSwitch.		 string
mac_pool_id Allocation mac pool associated with the Logical switch

Mac pool id that associated with a LogicalSwitch.		 string
replication_mode Replication mode of the Logical Switch string Enum: MTEP, SOURCE
resource_type Must be set to the value LogicalSwitch string
switching_profile_ids array of SwitchingProfileTypeIdEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_zone_id Id of the TransportZone to which this LogicalSwitch is associated string Required
uplink_teaming_policy_name The name of the switching uplink teaming policy for the logical switch

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.		 string
vlan VLAN Id of logical switch

This property is dedicated to VLAN based network, to set VLAN of logical
network. It is mutually exclusive with 'vlan_trunk_spec'.
VlanID
vlan_trunk_spec VLAN trunk spec of logical switch

This property is used for VLAN trunk specification of logical switch.
It's mutually exclusive with 'vlan'. Also it could be set to do guest VLAN
tagging in overlay network.
VlanTrunkSpec
vni VNI for this LogicalSwitch.

Only for OVERLAY network. A VNI will be auto-allocated from the
default VNI pool if not given; otherwise the given VNI has to be
inside the default pool and not used by any other LogicalSwitch.
int

LogicalSwitchInfo (schema)

Name Description Type Notes
instances_count Number of instances on this logical switch integer Readonly
is_default_logical_switch Flag to identify if this is the default logical switch boolean Readonly
logical_switch_display_name Name of the logical switch string Readonly
logical_switch_id ID of the logical switch string Readonly
nsx_switch_tag This tag is applied on cloud compute resource to be attached to this logical switch string Readonly

LogicalSwitchListParameters (schema)

Logical Switch list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
diagnostic Flag to enable showing of transit logical switch. boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
switching_profile_id Switching Profile identifier string
transport_type Mode of transport supported in the transport zone for this logical switch TransportType
transport_zone_id Transport zone identifier string
uplink_teaming_policy_name The logical switch's uplink teaming policy name string
vlan Return VLAN logical switches whose "vlan" field matches this value VlanID
vni VNI of the OVERLAY LogicalSwitch(es) to return. int

LogicalSwitchListResult (schema)

Logical Switch queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Logical Switch Results array of LogicalSwitch Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalSwitchListWithSourceParameters (schema)

Logical Switch list with data source parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
diagnostic Flag to enable showing of transit logical switch. boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
switching_profile_id Switching Profile identifier string
transport_type Mode of transport supported in the transport zone for this logical switch TransportType
transport_zone_id Transport zone identifier string
uplink_teaming_policy_name The logical switch's uplink teaming policy name string
vlan Return VLAN logical switches whose "vlan" field matches this value VlanID
vni VNI of the OVERLAY LogicalSwitch(es) to return. int

LogicalSwitchMirrorSource (schema)

Name Description Type Notes
resource_type Must be set to the value LogicalSwitchMirrorSource MirrorSourceResourceType Required
switch_id Source logical switch identifier string Required

LogicalSwitchState (schema)

Name Description Type Notes
details Array of configuration state of various sub systems array of ConfigurationStateElement Readonly
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
logical_switch_id Id of the logical switch string Readonly
state Overall state of desired configuration

Gives details of state of desired configuration		 string Required
Readonly
Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown

LogicalSwitchStateListResult (schema)

Logical Switch state queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Logical Switch State Results array of LogicalSwitchState Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LogicalSwitchStatus (schema)

Name Description Type Notes
logical_switch_id Unique ID identifying the the Logical Switch string Readonly
num_logical_ports Count of Logical Ports belonging to this switch int Readonly

LogicalSwitchStatusListResult (schema)

Logical Switch runtime status queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results LogicalSwitchStatus Results array of LogicalSwitchStatus Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

LoginCredential (schema)

Base type for various login credential types

Name Description Type Notes
credential_type Login credential, for example username-password-thumbprint or certificate based, etc

Possible values are 'UsernamePasswordLoginCredential', 'VerifiableAsymmetricLoginCredential'.		 string Required

MACAddress (schema)

MAC Address

A MAC address. Must be 6 pairs of hexadecimal digits, upper or lower case,
separated by colons or dashes. Examples: 01:23:45:67:89:ab, 01-23-45-67-89-AB.

Name Description Type Notes
MACAddress MAC Address

A MAC address. Must be 6 pairs of hexadecimal digits, upper or lower case,
separated by colons or dashes. Examples: 01:23:45:67:89:ab, 01-23-45-67-89-AB.
string Pattern: "^(([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2}))|(([0-9A-Fa-f]{2}[-]){5}([0-9A-Fa-f]{2}))$"

MACAddressElement (schema)

MAC Address

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
mac_address MACAddress Required

MACAddressElementListResult (schema)

Collection of MAC address elements

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results MAC address element list array of MACAddressElement Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

MACSet (schema)

Set of one or more MAC addresses

MACSet is used to group individual MAC addresses. MACSets can be used as
sources and destinations in layer2 firewall rules. These can also be used as
members of NSGroups.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
mac_addresses MAC addresses array of MACAddress Maximum items: 4000
resource_type Must be set to the value MACSet string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

MACSetListRequestParameters (schema)

MACSet list request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

MACSetListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged collection of MACSets array of MACSet Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

MacAddressCsvListResult (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
results array of MacTableCsvRecord

MacAddressListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
logical_switch_id The id of the logical Switch string Required
Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results array of MacTableEntry
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly
transport_node_id Transport node identifier string Readonly

MacAddressType (schema)

The type of the MAC address

Name Description Type Notes
MacAddressType The type of the MAC address string Enum: STATIC, LEARNED

MacLearningSpec (schema)

MAC learning configuration

Name Description Type Notes
aging_time Aging time in sec for learned MAC address int Readonly
Default: "300"
enabled Allowing source MAC address learning boolean Required
limit The maximum number of MAC addresses that can be learned on this port int Minimum: 0
Maximum: 4096
Default: "4096"
limit_policy The policy after MAC Limit is exceeded string Enum: ALLOW, DROP
Default: "ALLOW"
unicast_flooding_allowed Allowing flooding for unlearned MAC for ingress traffic boolean Default: "True"

MacManagementSwitchingProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
mac_change_allowed Allowing source MAC address change boolean Default: "False"
mac_learning MAC learning configuration MacLearningSpec
required_capabilities array of string Readonly
resource_type Must be set to the value MacManagementSwitchingProfile string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

MacPool (schema)

A collection of ranges of MAC addresses

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
ranges Array of ranges for MAC addresses array of MacRange Required
resource_type Must be set to the value MacPool string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

MacPoolListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results MAC pool list results array of MacPool Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

MacRange (schema)

A range of MAC addresses with a start and end value

Name Description Type Notes
end End value of MAC range

End value for MAC address range		 MACAddress Required
start Start value of MAC range

Start value for MAC address range		 MACAddress Required

MacTableCsvRecord (schema)

Name Description Type Notes
mac_address The MAC address string Required
vtep_ip The virtual tunnel endpoint IP address IPAddress
vtep_mac_address The virtual tunnel endpoint MAC address string

MacTableEntry (schema)

Name Description Type Notes
mac_address The MAC address string Required
vtep_ip The virtual tunnel endpoint IP address IPAddress
vtep_mac_address The virtual tunnel endpoint MAC address string

MaintenanceModeState (schema)

maintenance mode state

Name Description Type Notes
MaintenanceModeState maintenance mode state string Readonly
Enum: ENTERING, ENABLED, EXITING, DISABLED

ManagedResource (schema)

Base type for resources that are managed by API clients

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type The type of this resource. string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ManagementClusterNodeStatus (schema)

Name Description Type Notes
mgmt_cluster_status Status of this node's connection to the management cluster ClusteringStatus Readonly

ManagementClusterRoleConfig (schema)

Name Description Type Notes
api_listen_addr The IP and port for the public API service on this node ServiceEndpoint Readonly
mgmt_cluster_listen_addr The IP and port for the management cluster service on this node ServiceEndpoint Readonly
mgmt_plane_listen_addr The IP and port for the management plane service on this node ServiceEndpoint Readonly
mpa_msg_client_info MsgClientInfo
type Type of this role configuration string Required
Readonly
Enum: ManagementClusterRoleConfig, ControllerClusterRoleConfig

ManagementClusterStatus (schema)

Name Description Type Notes
offline_nodes Current missing management plane nodes array of ManagementPlaneBaseNodeInfo Readonly
online_nodes Current alive management plane nodes array of ManagementPlaneBaseNodeInfo Readonly
required_members_for_initialization The details of the cluster nodes required for cluster initialization array of ClusterInitializationNodeInfo Readonly
status The current status of the management cluster string Readonly
Enum: INITIALIZING, UNSTABLE, STABLE, UNKNOWN

ManagementConfig (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
publish_fqdns True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability. boolean Required

ManagementNodeAggregateInfo (schema)

Name Description Type Notes
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
id Unique identifier of this resource string Readonly
node_interface_properties Array of Node interface statistic properties array of NodeInterfaceProperties Readonly
node_interface_statistics Array of Node network interface statistic properties array of NodeInterfaceStatisticsProperties Readonly
node_status ClusterNodeStatus Readonly
node_status_properties Time series of the node's system properties array of NodeStatusProperties
role_config ManagementClusterRoleConfig Readonly
transport_nodes_connected integer Readonly
Minimum: 0

ManagementPlaneBaseNodeInfo (schema)

The basic node info of management plane node

Name Description Type Notes
mgmt_cluster_listen_ip_address The IP address of MP node string Readonly
uuid Management plane node UUID string Readonly

MandatoryAccessControlProperties (schema)

Information about mandatory access control

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
enabled Enabled can be True/False boolean
status current status of Mandatory Access Control string Readonly
Enum: ENABLED, DISABLED, ENABLED_PENDING_REBOOT

MetadataProxy (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
attached_logical_port_id id of attached logical port string Readonly
crypto_protocols metadata proxy supported cryptographic protocols.

The cryptographic protocols listed here are supported by the metadata proxy.
The TLSv1.1 and TLSv1.2 are supported by default.
array of MetadataProxyCryptoProtocol
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
edge_cluster_id edge cluster uuid string Required
edge_cluster_member_indexes edge cluster member indexes

If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster.
If user provides only one edge node, there will be no HA support.
array of integer Minimum items: 0
Maximum items: 2
id Unique identifier of this resource string Readonly
Sortable
metadata_server_ca_ids uuids of CAs to verify metadata server certificate

The CAs referenced here must be uploaded to the truststore using the API
POST /api/v1/trust-management/certificates?action=import.
User needs to ensure a correct CA for this metedata server is used. The REST API can
not detect a wrong CA which was used to verify a different server. If the Metadata
Proxy reports an ERROR or NO_BACKUP status, user can check the metadata proxy log
at transport node for a possible CA issue.
array of string
metadata_server_url metadata server url

The URL in format scheme://host:port/path. Please note, the scheme supports only http
and https as of now, port supports range 3000 - 9000, inclusive.
string Required
resource_type Must be set to the value MetadataProxy string
secret secret to access metadata server string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

MetadataProxyCryptoProtocol (schema)

Metadata proxy supported cryptographic protocol

Name Description Type Notes
MetadataProxyCryptoProtocol Metadata proxy supported cryptographic protocol string Enum: TLS_V1, TLS_V1_1, TLS_V1_2

MetadataProxyListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results paginated list of metadata proxies array of MetadataProxy Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

MetadataProxyStatisticsRequestParameters (schema)

Name Description Type Notes
logical_switch_id The uuid of logical switch string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType

MgmtConnStatus (schema)

Name Description Type Notes
connectivity_status Indicates the controller node's MP channel connectivity status string Readonly
Enum: CONNECTED, DISCONNECTED, UNKNOWN

MirrorDestination (schema)

This is an abstract type. Concrete child types:
IPMirrorDestination
LogicalPortMirrorDestination
PnicMirrorDestination

Name Description Type Notes
resource_type MirrorDestinationResourceType Required

MirrorDestinationResourceType (schema)

Resource types of mirror destination

Name Description Type Notes
MirrorDestinationResourceType Resource types of mirror destination string Enum: LogicalPortMirrorDestination, PnicMirrorDestination, IPMirrorDestination

MirrorSource (schema)

This is an abstract type. Concrete child types:
LogicalPortMirrorSource
LogicalSwitchMirrorSource
PnicMirrorSource
VlanMirrorSource

Name Description Type Notes
resource_type MirrorSourceResourceType Required

MirrorSourceResourceType (schema)

Resource types of mirror source

Name Description Type Notes
MirrorSourceResourceType Resource types of mirror source string Enum: LogicalPortMirrorSource, PnicMirrorSource, VlanMirrorSource, LogicalSwitchMirrorSource

MonitorQueryType (schema)

monitor query type

MonitorQueryType is used to query load balancer monitors.
LbActiveMonitor represents active load balancer monitors.
While LbActiveMonitor is specified to query load balancer
monitors, it returns all active monitors, including LbHttpMonitor,
LbHttpMonitor, LbIcmpMonitor, LbTcpMonitor,
LbUdpMonitor.

Name Description Type Notes
MonitorQueryType monitor query type

MonitorQueryType is used to query load balancer monitors.
LbActiveMonitor represents active load balancer monitors.
While LbActiveMonitor is specified to query load balancer
monitors, it returns all active monitors, including LbHttpMonitor,
LbHttpMonitor, LbIcmpMonitor, LbTcpMonitor,
LbUdpMonitor.
string Enum: LbHttpMonitor, LbHttpsMonitor, LbIcmpMonitor, LbTcpMonitor, LbUdpMonitor, LbPassiveMonitor, LbActiveMonitor

MonitorType (schema)

monitor type

Load balancers monitor the health of backend servers to ensure traffic
is not black holed.
There are two types of healthchecks: active and passive.
Passive healthchecks depend on failures in actual client traffic (e.g. RST
from server in response to a client connection) to detect that the server
or the application is down.
In case of active healthchecks, load balancer itself initiates new
connections (or sends ICMP ping) to the servers periodically to check their
health, completely independent of any data traffic.
Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP
and ICMP protocols.

Name Description Type Notes
MonitorType monitor type

Load balancers monitor the health of backend servers to ensure traffic
is not black holed.
There are two types of healthchecks: active and passive.
Passive healthchecks depend on failures in actual client traffic (e.g. RST
from server in response to a client connection) to detect that the server
or the application is down.
In case of active healthchecks, load balancer itself initiates new
connections (or sends ICMP ping) to the servers periodically to check their
health, completely independent of any data traffic.
Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP
and ICMP protocols.
string Enum: LbHttpMonitor, LbHttpsMonitor, LbIcmpMonitor, LbTcpMonitor, LbUdpMonitor, LbPassiveMonitor

MonthlyTelemetrySchedule (schema)

Name Description Type Notes
day_of_month Day of month on which data will be collected

Day of month on which data will be collected. Specify a value between 1 through 31.
integer Required
Minimum: 1
Maximum: 31
frequency_type Must be set to the value MonthlyTelemetrySchedule string Required
hour_of_day Hour at which data will be collected

Hour at which data will be collected. Specify a value between 0 through 23.
integer Required
Minimum: 0
Maximum: 23
minutes Minute at which data will be collected

Minute at which data will be collected. Specify a value between 0 through 59.
integer Minimum: 0
Maximum: 59
Default: "0"

MsgClientInfo (schema)

Information about a messaging client

Name Description Type Notes
account_name Account name for the messaging client. Identifies the client on the management plane message bus. string
certificate Messaging client's certificate. Used to authenticate to the control plane messaging endpoint. string
shared_secret Messaging client's secret. Used to authenticate to the management plane messaging broker. string
software_version Software version of the node. string Readonly

MultiWidgetConfiguration (schema)

Multi-Widget

Combines two or more widgetconfigurations into a multi-widget

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
datasources Array of Datasource Instances with their relative urls

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.		 array of Datasource Minimum items: 0
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
drilldown_id Id of drilldown widget

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.		 string Maximum length: 255
footer Footer
id Unique identifier of this resource string Readonly
Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.		 boolean Default: "False"
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details.		 string Maximum length: 1024
resource_type Must be set to the value MultiWidgetConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration
Maximum length: 255
shared Visiblity of widgets to other users

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.		 boolean Deprecated
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.		 int Deprecated
widgets Widgets

Array of widgets that are part of the multi-widget.		 array of WidgetItem Required
Minimum items: 1
Maximum items: 2

NSGroup (schema)

Networking and Security Group

NSGroups are recursive groupings of different NSX elements (logical and physical), typically used in policy definitions.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
member_count Count of the members added to this NSGroup integer Readonly
members Members of NSGroup

Reference to the direct/static members of the NSGroup.
Can be ID based expressions only. VirtualMachine cannot
be added as a static member.
array of NSGroupSimpleExpression Maximum items: 500
membership_criteria The criteria for membership of this NSGroup

List of tag or name based expressions which define the dynamic membership criteria
for this NSGroup. An object must satisfy atleast one of these expressions
to qualify as a member of this group.
array of NSGroupExpression
(Abstract type: pass one of the following concrete types)
NSGroupComplexExpression
NSGroupExpression
NSGroupSimpleExpression
NSGroupTagExpression		 Maximum items: 5
resource_type Must be set to the value NSGroup string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

NSGroupComplexExpression (schema)

Complex expressions to represent NSGroup membership

Name Description Type Notes
expressions List of simple and tag expressions

Represents expressions which are to be logically 'AND'ed.The array cannot contain
NSGroupComplexExpression.Only NSGroupTagExpression and NSGroupSimpleExpressions
are accepted.
array of NSGroupExpression
(Abstract type: pass one of the following concrete types)
NSGroupComplexExpression
NSGroupExpression
NSGroupSimpleExpression
NSGroupTagExpression		 Required
Minimum items: 2
Maximum items: 5
resource_type Must be set to the value NSGroupComplexExpression string Required
Enum: NSGroupSimpleExpression, NSGroupComplexExpression, NSGroupTagExpression

NSGroupExpression (schema)

Policy expression for NSGroup membership

Name Description Type Notes
resource_type string Required
Enum: NSGroupSimpleExpression, NSGroupComplexExpression, NSGroupTagExpression

NSGroupListRequestParameters (schema)

NSGroup list request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
member_types Specify member types to filter corresponding NSGroups

Specify valid member types in CSV format to filter NSGroups. Returns NSGroups
whose member types are same as or subset of specified member types
string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
populate_references Populate metadata of resource referenced by NSGroupExpressions

If set to true, the target_resource property of each
NSGroupExpresion will be populated from the associated resource
when the expression uniquely identifies a resource.
boolean Default: "False"
sort_ascending boolean
sort_by Field by which records are sorted string

NSGroupListResult (schema)

Paged Collection of NSGroups

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results NSGroup list results array of NSGroup Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NSGroupMetaInfo (schema)

Metadata about NSGroup

Contains the metadata of a NSGroup when the application discovery session
was started

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
no_of_vms Number of VMs discovered for this NSGroup when session was started integer
ns_group_id ID of the NS Group string Required

NSGroupMetaInfoListResult (schema)

NSGroupMetaInfo list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results list of NSGroupMetaInfos array of NSGroupMetaInfo Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NSGroupServiceAssociationListRequestParameters (schema)

NSGroup Service association list request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
fetch_parentgroup_associations Fetch complete list of associated resources considering nesting

If set to true, will fetch direct as well as
indirect associated service entities for the given NSGroup.
boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
service_type string Required
Enum: firewall, ipfix
sort_ascending boolean
sort_by Field by which records are sorted string

NSGroupSimpleExpression (schema)

Simple expressions to represent NSGroup membership

Name Description Type Notes
op Operator of the expression string Required
Enum: EQUALS, CONTAINS, STARTSWITH
resource_type Must be set to the value NSGroupSimpleExpression string Required
Enum: NSGroupSimpleExpression, NSGroupComplexExpression, NSGroupTagExpression
target_property Field of the resource on which this expression is evaluated string Required
target_resource Reference of the target

Reference of the target. Will be populated when
the property is a resource id, the op (operator) is EQUALS and
populate_references is set to be true.
ResourceReference Readonly
target_type Type of the resource on which this expression is evaluated NSGroupValidResourceType Required
value Value that satisfies this expression string Required

NSGroupTagExpression (schema)

TAG expressions to represent NSGroup membership

Includes both scope and tag attribute of Tag. The scope and tag expressions
are logically 'AND' with each other.
eg- tag.scope = "S1" AND tag.tag = 'T1'

Name Description Type Notes
resource_type Must be set to the value NSGroupTagExpression string Required
Enum: NSGroupSimpleExpression, NSGroupComplexExpression, NSGroupTagExpression
scope The tag.scope attribute of the object string Maximum length: 128
scope_op Operator of the scope expression eg- tag.scope = "S1". string Enum: EQUALS
Default: "EQUALS"
tag The tag.tag attribute of the object string Maximum length: 256
tag_op Operator of the tag expression eg- tag.tag = "Production" string Enum: EQUALS
Default: "EQUALS"
target_type Type of the resource on which this expression is evaluated string Required
Enum: LogicalSwitch, LogicalPort, VirtualMachine

NSGroupValidResourceType (schema)

Resource type valid for use in an NSGroupExpression

Name Description Type Notes
NSGroupValidResourceType Resource type valid for use in an NSGroupExpression string Enum: NSGroup, IPSet, MACSet, LogicalSwitch, LogicalPort, VirtualMachine, DirectoryGroup

NSService (schema)

A Networking and Security Service allows users to specify characteristics to use
for matching network traffic. For example the user can specify port and protocol
pair.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
default_service NSServices created in the system by default

The default NSServices are created in the system by default. These NSServices
can't be modified/deleted
boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
nsservice_element An NSService Element that describes traffic corresponding to this NSService NSServiceElement
(Abstract type: pass one of the following concrete types)
ALGTypeNSService
EtherTypeNSService
ICMPTypeNSService
IGMPTypeNSService
IPProtocolNSService
L4PortSetNSService		 Required
resource_type Must be set to the value NSService string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

NSServiceElement (schema)

An NSService element that describes traffic corresponding to an NSService

This is an abstract type. Concrete child types:
ALGTypeNSService
EtherTypeNSService
ICMPTypeNSService
IGMPTypeNSService
IPProtocolNSService
L4PortSetNSService

Name Description Type Notes
resource_type The specific type of NSServiceElement string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

NSServiceGroup (schema)

A Networking and Security Service Group that represents a group of NSServices

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
default_service NSServiceGroups created in the system by default

The default NSServiceGroups are created in the system by default. These
NSServiceGroups can't be modified/deleted
boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
members List of NSService or NSServiceGroup resources that can be added as members
to an NSServiceGroup.
array of ResourceReference Required
Maximum items: 50
resource_type Must be set to the value NSServiceGroup string
service_type Type of the NSServiceGroup string Readonly
Enum: ETHER, NON_ETHER
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

NSServiceGroupListRequestParameters (schema)

NSServiceGroup list request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
default_service Fetch all default NSServiceGroups

If set to true, then it will display only default
NSServiceGroups. If set to false, then it will display all those
NSServiceGroups which are not default. If it is not provided,
then complete (default as well as non default) list of
NSServiceGroups will be displayed.
boolean
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

NSServiceGroupListResult (schema)

List result of NSServiceGroups

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged collection of NSServiceGroups array of NSServiceGroup Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NSServiceListRequestParameters (schema)

NSService list request parameters.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
default_service Fetch all default NSServices

If set to true, then it will display only default NSServices. If
set to false, then it will display all those NSServices which are not
default. If it is not provided, then complete (default
as well as non default) list of NSServices will be displayed.
boolean
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

NSServiceListResult (schema)

List result of NSservices

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged collection of NSServices array of NSService Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NamedTeamingPolicy (schema)

Uplink Teaming Policy with a name that can be referenced by logical switches

Name Description Type Notes
active_list List of Uplinks used in active list array of Uplink Required
name The name of the uplink teaming policy

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.		 string Required
policy Teaming policy string Required
Enum: FAILOVER_ORDER, LOADBALANCE_SRCID
standby_list List of Uplinks used in standby list array of Uplink

NatActions (schema)

NAT action types

NAT action types. Please note, the NO_NAT was deprecated. Please use the
alternative NO_SNAT or NO_DNAT.

Name Description Type Notes
NatActions NAT action types

NAT action types. Please note, the NO_NAT was deprecated. Please use the
alternative NO_SNAT or NO_DNAT.
string Enum: SNAT, DNAT, NO_NAT, REFLEXIVE, NO_SNAT, NO_DNAT

NatRule (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
action NAT rule action type.

valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE. All rules
in a logical router are either stateless or stateful. Mix is not
supported. SNAT and DNAT are stateful, can NOT be supported when
the logical router is running at active-active HA mode; REFLEXIVE
is stateless. NO_SNAT and NO_DNAT have no translated_fields, only
match fields are supported.
NatActions Required
applied_tos List of LogicalRouterPort resources as applied to

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.		 array of ResourceReference Maximum items: 1
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled enable/disable the rule boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
logging enable/disable the logging of rule boolean Default: "False"
logical_router_id Logical router id string Readonly
match_destination_network match destination network

IP Address | CIDR | (null implies Any)
string
match_service match service on source port, destination port, protocol, icmp, etc

A NSServiceElement that specifies the matching services of source
ports, destination ports, ip protocol version and number, sub protocol
version and number, ICMP type and code, etc.
The match_service can be one of IPProtocolNSService,L4PortSetNSService
or ICMPTypeNSService. REFLEXIVE NAT does not support match_service.
NSServiceElement
(Abstract type: pass one of the following concrete types)
ALGTypeNSService
EtherTypeNSService
ICMPTypeNSService
IGMPTypeNSService
IPProtocolNSService
L4PortSetNSService
match_source_network match source network

IP Address | CIDR | (null implies Any)
string
nat_pass enable/disable to bypass following firewall stage

Default is true. If the nat_pass is set to true, the following firewall
stage will be skipped. Please note, if action is NO_NAT, then nat_pass
must be set to true or omitted.
boolean Default: "True"
resource_type Must be set to the value NatRule string
rule_priority NAT rule priority

Ascending, valid range [0-2147483647]. If multiple rules have the same
priority, evaluation sequence is undefined.
integer Default: "1024"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
translated_network IP Address | IP Range | CIDR string
translated_ports port number or port range. DNAT only string

NatRuleListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results NAT rule list results array of NatRule Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NeighborProperties (schema)

Neighbor properties

Name Description Type Notes
capabilities Capabilities string Readonly
enabled_capabilities Enabled capabilities string Readonly
ifindex Interface index integer Readonly
link_aggregation_capable Aggregation Capability boolean Readonly
link_aggregation_port_id Aggregation port id string Readonly
link_aggregation_status Aggregation Status

True if currently in aggregation		 boolean Readonly
mac Interface MAC address string Readonly
Pattern: "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$"
mgmt_addr Management address string Readonly
name Interface name string Readonly
oid Object identifier string Readonly
port_desc Port description string Readonly
system_desc System description string Readonly
system_name System name string Readonly
system_port_number System port number integer Readonly

NetworkMigrationSpec (schema)

Abstract base type for network migration specification

The NetworkMigrationSpec is the base class for any types of network migration
specifications to be handled by transport node.
This is an abstract type. Concrete child types:
HostProfileNetworkMigrationSpec

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value NetworkMigrationSpec NetworkMigrationSpecType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

NetworkMigrationSpecListParameters (schema)

NetworkMigrationSpec List Parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
include_system_owned Whether the list result contains system resources boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
type Type of network migration specification. NetworkMigrationSpecType

NetworkMigrationSpecListResult (schema)

Network migration specification template list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Network migration specification template results array of NetworkMigrationSpec
(Abstract type: pass one of the following concrete types)
HostProfileNetworkMigrationSpec		 Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NetworkMigrationSpecType (schema)

Supported network migration specification types.

Name Description Type Notes
NetworkMigrationSpecType Supported network migration specification types. string Enum: HostProfileNetworkMigrationSpec

NetworkMigrationSpecTypeIdEntry (schema)

Name Description Type Notes
key the type of the NetworkMigrationSpec NetworkMigrationSpecType Readonly
value the id of the NetworkMigrationSpec string Required

NicInfo (schema)

NIC information

Information of a network interface present on the partner appliance that needs to be configured by the NSX Manager.

Name Description Type Notes
gateway_address Gateway address

Gateway address associated with the NIC metadata.		 string
ip_address IP address

IP address associated with the NIC metadata.		 string
network_id Network Id

Network Id associated with the NIC metadata.		 string
nic_metadata NIC metadata

NIC metadata information.		 NicMetadata Required
Readonly
subnet_mask Subnet mask

Subnet mask associated with the NIC metadata.		 string

NicMetadata (schema)

NIC Metadata

Information on the Network interfaces present on the partner appliance that needs to be configured by the NSX Manager.

Name Description Type Notes
interface_index Interface Index

Network Interface index.		 integer Required
interface_label Interface label

Network Interface label.		 string Required
interface_type Interface type

Interface that needs to be configured on the partner appliance. Ex. MANAGEMENT, DATA1, DATA2, HA1, HA2.		 string Required
Enum: MANAGEMENT, DATA1, DATA2, HA1, HA2

NiocProfile (schema)

Profile for Nioc

This profile is created for Network I/O Control(NIOC).

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enabled status of NIOC feature

The enabled property specifies the status of NIOC feature.
When enabled is set to true, NIOC feature is turned on and
the bandwidth allocations specified for the traffic resources
are enforced. When enabled is set to false, NIOC feature
is turned off and no bandwidth allocation is guaranteed.
By default, enabled will be set to true.
boolean Default: "True"
host_infra_traffic_res Resource allocation associated with NiocProfile

host_infra_traffic_res specifies bandwidth allocation for
various traffic resources.
array of ResourceAllocation
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value NiocProfile HostSwitchProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

NoRestRequestParameters (schema)

Parameter definition for requests that do not allow parameters.

Name Description Type Notes
NoRestRequestParameters Parameter definition for requests that do not allow parameters. object

Node (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
discovered_ip_addresses Discovered IP Addresses of the fabric node, version 4 or 6 array of IPAddress Readonly
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id ID of the Node maintained on the Node and used to recognize the Node string
fqdn Fully qualified domain name of the fabric node string Readonly
id Unique identifier of this resource string Readonly
Sortable
ip_addresses IP Addresses of the Node, version 4 or 6

IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for
automatic deployment of edge virtual machine node. For automatic deployment, the ip address from
management_port_subnets property will be considered.
array of IPAddress
resource_type Must be set to the value Node string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

NodeAggregateInfo (schema)

Aggregation of desired and runtime status of fabric node

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
node Node attributes Node
(Abstract type: pass one of the following concrete types)
EdgeNode
HostNode
Node
PublicCloudGatewayNode		 Readonly
resource_type Must be set to the value NodeAggregateInfo string
status Node status NodeStatus Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

NodeAggregateInfoListResult (schema)

Node aggregate state list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node Aggregate Info Results array of NodeAggregateInfo Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeAggregationListRequestParameters (schema)

Node list parameters

Request object, containing two properties, based on
which the result will be filtered. None, or only one,
or both the properties can be passed as filter criteria.
If both properties are populated then result will be
the intersection of two resulsets by applying both
filters individually.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
node_deployment_status Install/Uninstall status of deployment

List nodes based on deployment status of fabric nodes,
if not provided then lists all discovered and fabric nodes
irrespective of the fabric node status
string Enum: SUCCESSFUL, ERROR, UNKNOWN
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
transport_nodes filter whether fabric node is configured as transport node or not, true or false boolean

NodeAuthProviderVidmProperties (schema)

Node AAA provider vIDM properties

Name Description Type Notes
client_id vIDM client id string Required
client_secret vIDM client secret string
host_name Fully Qualified Domain Name(FQDN) of vIDM string Required
node_host_name host name of the node redirected to

host name to use when creating the redirect URL for clients to follow after authenticating to vIDM		 string Required
thumbprint vIDM certificate thumbprint

Hexadecimal SHA256 hash of the vIDM server's X.509 certificate		 string Required
vidm_enable vIDM enable flag boolean

NodeAuthProviderVidmStatus (schema)

Node AAA provider vIDM status

Name Description Type Notes
runtime_state AAA provider vIDM status string Required
vidm_enable vIDM enable flag boolean Required

NodeFileSystemProperties (schema)

File system properties

Name Description Type Notes
file_system File system id string Readonly
mount File system mount string Readonly
total File system size in kilobytes integer Readonly
type File system type string Readonly
used Amount of file system used in kilobytes integer Readonly

NodeHttpServiceProperties (schema)

Node HTTP service properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
service_name Service name string Required
service_properties HTTP Service properties HttpServiceProperties

NodeIdServicesMap (schema)

Name Description Type Notes
node_id NodeId string Required
Maximum length: 255
service_types list of ServiceTypes array of ServiceType Required

NodeInfo (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
component_version Component version of the node string Required
Readonly
display_name Name of the node string Required
Readonly
id UUID of node

Identifier of the node		 string Required
Readonly
type Node type string Required
Readonly

NodeInfoListRequestParameters (schema)

Name Description Type Notes
component_type Component type based on which nodes will be filtered string
component_version Component version based on which nodes will be filtered string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

NodeInfoListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged Collection of Nodes array of NodeInfo Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeInstallUpgradeServiceProperties (schema)

Node install-upgrade service properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
service_name Service name string Required
service_properties install-upgrade Service properties InstallUpgradeServiceProperties

NodeInterfaceAlias (schema)

Node network interface alias

Name Description Type Notes
broadcast_address Interface broadcast address IPAddress Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
ip_address Interface IP address IPAddress Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
ip_configuration Interface configuration string Enum: dhcp, static, not configured
netmask Interface netmask string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
physical_address Interface MAC address MACAddress

NodeInterfaceProperties (schema)

Node network interface properties

Name Description Type Notes
admin_status Interface administration status string Enum: UP, DOWN
connected_switch Connected switch string
ens_capable Interface capability for Enhanced Networking Stack boolean
ens_enabled Indicates whether interface is enabled for Enhanced Networking Stack boolean
interface_alias IP Alias array of NodeInterfaceAlias
interface_id Interface ID string
interface_type Interface Type string Enum: PHYSICAL, VIRTUAL
link_status Interface administration status string Enum: UP, DOWN
mtu Interface MTU integer
source Source of status data DataSourceType

NodeInterfacePropertiesListResult (schema)

Node network interface properties list results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node interface property results array of NodeInterfaceProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeInterfaceStatisticsProperties (schema)

Node network interface statistic properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
interface_id Interface ID string
rx_bytes Number of bytes received integer
rx_dropped Number of packets dropped integer
rx_errors Number of receive errors integer
rx_frame Number of framing errors integer
rx_packets Number of packets received integer
source Source of status data. DataSourceType
tx_bytes Number of bytes transmitted integer
tx_carrier Number of carrier losses detected integer
tx_colls Number of collisions detected integer
tx_dropped Number of packets dropped integer
tx_errors Number of transmit errors integer
tx_packets Number of packets transmitted integer

NodeListRequestParameters (schema)

Node list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
discovered_node_id Id of the discovered node which was converted to create this node string
display_name HostNode display name string
external_id HostNode external id string
hardware_id Hardware Id of the host

HardwareId of the host is used to get fabric node on reboot.		 string
hypervisor_os_type HostNode's Hypervisor type, for example ESXi, RHEL KVM or UBUNTU KVM. string Enum: ESXI, RHELKVM, UBUNTUKVM, HYPERV, RHELCONTAINER, RHELSERVER, UBUNTUSERVER, CENTOSSERVER, CENTOSKVM
included_fields Comma separated list of fields that should be included in query result string
ip_address Management IP address of the node string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_type Node type from 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode' string Enum: HostNode, EdgeNode, PublicCloudGatewayNode
sort_ascending boolean
sort_by Field by which records are sorted string

NodeListResult (schema)

Node list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node list results array of Node
(Abstract type: pass one of the following concrete types)
EdgeNode
HostNode
Node
PublicCloudGatewayNode		 Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeLogProperties (schema)

Node log properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
last_modified_time Last modified time expressed in milliseconds since epoch EpochMsTimestamp Readonly
log_name Name of log file string Readonly
log_size Size of log file in bytes integer Readonly

NodeLogPropertiesListResult (schema)

Node log property query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node log property results array of NodeLogProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeMode (schema)

Stub for Nsx node modes

Possible values of a mode in a "/config/nsx_appliance_mode" file

Name Description Type Notes
mode_id Nsx node mode

Possible enum values in a "/config/nsx_appliance_mode" file		 string Required
Enum: ON_PREM, SERVICE, VMC, VMC_LOCAL

NodeNameServersProperties (schema)

Node network name servers properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
name_servers Name servers array of string Required
Maximum items: 3

NodeNetworkInterfaceProperties (schema)

Node network interface properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
admin_status Interface administration status string Readonly
Enum: up, down
bond_mode Bond mode string Enum: ACTIVE_BACKUP, 802_3AD
bond_primary Bond's primary device name in active-backup bond mode string
bond_slaves Bond's slave devices array of string
broadcast_address Interface broadcast address string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
default_gateway Interface's default gateway string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
interface_id Interface ID string Required
Readonly
ip_addresses Interface IP addresses array of IPv4AddressProperties Maximum items: 1
ip_configuration Interface configuration string Required
Enum: dhcp, static, not configured
link_status Interface administration status string Readonly
Enum: up, down
mtu Interface MTU integer
physical_address Interface MAC address string Readonly
Pattern: "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$"
plane Interface plane string Enum: mgmt, debug

NodeNetworkInterfacePropertiesListResult (schema)

Node network interface properties list results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node network interface property results array of NodeNetworkInterfaceProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeNetworkProperties (schema)

Network configuration properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly

NodeNtpServiceProperties (schema)

Node NTP service properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
service_name Service name string Required
service_properties NTP Service properties NtpServiceProperties

NodeProcessProperties (schema)

Node process properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cpu_time CPU time (user and system) consumed by process in milliseconds integer Readonly
mem_resident Resident set size of process in bytes integer Readonly
mem_used Virtual memory used by process in bytes integer Readonly
pid Process id integer Readonly
ppid Parent process id integer Readonly
process_name Process name string Readonly
start_time Process start time expressed in milliseconds since epoch EpochMsTimestamp Readonly
uptime Milliseconds since process started integer Readonly

NodeProcessPropertiesListResult (schema)

Node process property query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node process property results array of NodeProcessProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeProperties (schema)

Node properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
bios_uuid Node BIOS Unique Indentifier string Readonly
cli_timeout NSX CLI inactivity timeout, set to 0 to configure no timeout integer Minimum: 0
export_type Export restrictions in effect, if any string Readonly
Enum: RESTRICTED, UNRESTRICTED
hostname Host name or fully qualified domain name of node SystemHostname
kernel_version Kernel version string Readonly
motd Message of the day to display when users login to node using the NSX CLI string or null
node_uuid Node Unique Identifier string Maximum length: 36
node_version Node version string Readonly
product_version Product version string Readonly
system_time Current time expressed in milliseconds since epoch EpochMsTimestamp Readonly
timezone Timezone string

NodeProtonServiceProperties (schema)

Node service properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
service_name Service name string Required
service_properties Service properties ProtonServiceProperties

NodeRouteProperties (schema)

Node network route properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
destination Destination covered by route string
from_address From address string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
gateway Address of next hop string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
interface_id Network interface id of route string
metric Metric value of route string
netmask Netmask of destination covered by route string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"
proto Routing protocol identifier of route string Enum: unspec, redirect, kernel, boot, static, gated, ra, mrt, zebra, bird, dnrouted, xorp, ntk, dhcp
Default: "boot"
route_id Unique identifier for the route string Readonly
route_type Route type string Required
Enum: default, static, blackhole, prohibit, throw, unreachable
scope Scope of destinations covered by route string
src Source address to prefer when sending to destinations of route string Pattern: "^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$"

NodeRoutePropertiesListResult (schema)

Node network route properties list results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node route property results array of NodeRouteProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeSearchDomainsProperties (schema)

Node network search domains properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
search_domains Search domains array of string Required

NodeServiceProperties (schema)

Node service properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
service_name Service name string Required

NodeServicePropertiesListResult (schema)

Node service property query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node service property results array of NodeServiceProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeServiceStatusProperties (schema)

Node service status properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
monitor_pid Service monitor process id integer Readonly
monitor_runtime_state Service monitor runtime state string Readonly
Enum: running, stopped
pids Service process ids array of integer Readonly
runtime_state Service runtime state string Readonly
Enum: running, stopped

NodeSnmpServiceProperties (schema)

Node SNMP service properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
service_name Service name string Required
service_properties SNMP Service properties SnmpServiceProperties Required

NodeSshServiceProperties (schema)

Node SSH service properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
service_name Service name string Required
service_properties SSH Service properties SshServiceProperties

NodeStatus (schema)

Runtime status information of the fabric node.

Name Description Type Notes
external_id HostNode external id string
host_node_deployment_status Install/Uninstall status of deployment.

This enum specifies the current nsx install state for host node or
current deployment and ready state for edge node.
The ready status 'NODE_READY' indicates whether edge node is
ready to become a transport node.
The status 'EDGE_CONFIG_ERROR' indicates that edge hardware or underlying
host is not supported.
string Readonly
Enum: NOT_PREPARED, INSTALL_IN_PROGRESS, INSTALL_FAILED, INSTALL_SUCCESSFUL, UNINSTALL_IN_PROGRESS, UNINSTALL_FAILED, UNINSTALL_SUCCESSFUL, 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
inventory_sync_paused Is true if inventory sync is paused else false boolean Readonly
inventory_sync_reenable_time Inventory sync auto re-enable target time, in epoch milis EpochMsTimestamp Readonly
last_heartbeat_timestamp Timestamp of the last heartbeat status change, in epoch milliseconds. EpochMsTimestamp Readonly
last_sync_time Timestamp of the last successful update of Inventory, in epoch milliseconds. EpochMsTimestamp Readonly
lcp_connectivity_status Indicates the fabric node's LCP<->CCP channel connectivity status, UP, DOWN, DEGRADED, UNKNOWN. string Readonly
Enum: UP, DOWN, DEGRADED, UNKNOWN
Default: "UNKNOWN"
lcp_connectivity_status_details Details, if any, about the current LCP<->CCP channel connectivity status of the fabric node. array of ControlConnStatus Readonly
Default: "[]"
maintenance_mode Indicates the fabric node's status of maintenance mode, OFF, ENTERING, ON, EXITING. string Readonly
Enum: OFF, ENTERING, ON, EXITING
mpa_connectivity_status Indicates the fabric node's MP<->MPA channel connectivity status, UP, DOWN, UNKNOWN. string Readonly
Enum: UP, DOWN, UNKNOWN
mpa_connectivity_status_details Details, if any, about the current MP<->MPA channel connectivity status of the fabric node. string Readonly
software_version Software version of the fabric node. string Readonly
system_status Node status properties NodeStatusProperties Readonly

NodeStatusProperties (schema)

Node status properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cpu_cores Number of CPU cores on the system integer Readonly
file_systems File systems configured on the system array of NodeFileSystemProperties Readonly
load_average One, five, and fifteen minute load averages for the system array of number Readonly
mem_cache Amount of RAM on the system that can be flushed out to disk, in kilobytes integer Readonly
mem_total Amount of RAM allocated to the system, in kilobytes integer Readonly
mem_used Amount of RAM in use on the system, in kilobytes integer Readonly
source Source of status data. DataSourceType Readonly
swap_total Amount of disk available for swap, in kilobytes integer Readonly
swap_used Amount of swap disk in use, in kilobytes integer Readonly
system_time Current time expressed in milliseconds since epoch EpochMsTimestamp Readonly
uptime Milliseconds since system start integer Readonly

NodeSummary (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
component_version Component version string Required
Readonly
node_count Count of nodes

Number of nodes of the type and at the component version		 int Required
Readonly
type Node type string Required
Readonly

NodeSummaryList (schema)

Name Description Type Notes
results List of Node Summary array of NodeSummary Required

NodeSyslogExporterProperties (schema)

Node syslog exporter properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
exporter_name Syslog exporter name string Required
facilities Facilities to export array of SyslogFacility
level Logging level to export string Required
Enum: EMERG, ALERT, CRIT, ERR, WARNING, NOTICE, INFO, DEBUG
msgids MSGIDs to export array of string
port Port to export to integer Minimum: 1
Maximum: 65535
Default: "514"
protocol Export protocol string Required
Enum: TCP, TLS, UDP, LI, LI-TLS
server IP address or hostname of server to export to HostnameOrIPv4Address Required
structured_data Structured data to export array of string
tls_ca_pem CA certificate PEM of TLS server to export to string

NodeSyslogExporterPropertiesListResult (schema)

Node syslog exporter list results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Node syslog exporter results array of NodeSyslogExporterProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeUserProperties (schema)

Node user properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
full_name Full name for the user string
old_password Old password for the user (required on PUT if password specified) string
password Password for the user (optionally specified on PUT, unspecified on GET) string
userid Numeric id for the user integer Readonly
Minimum: 0
Maximum: 2147483647
username User login name (must be "root" if userid is 0) string Minimum length: 1
Maximum length: 32
Pattern: "^[a-zA-Z][a-zA-Z0-9@-_.\-]*$"

NodeUserPropertiesListResult (schema)

Node users list results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of node users array of NodeUserProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeUserSettings (schema)

Name Description Type Notes
audit_password Node audit user password

Password for the node audit user. For deployment,
this property is required. After deployment, this property is ignored, and
the node cli must be used to change the password.
The password specified must be at least 8 characters in length and must
contain at least one lowercase, one uppercase, one numeric character and one
special character (except quotes).
string Pattern: "^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[~`!@#$%^&*)(\-_\+\=}{\]\[|:;,?\.><])[A-Za-z\d~`!@#$%^&*)(\-_\+\=}{\]\[\|:;,?\.><]{8,}$"
audit_username CLI "audit" username

The default username is "audit". To configure username, you must provide
this property together with audit_password.
string
cli_password Node cli password

Password for the node cli user. For deployment,
this property is required. After deployment, this property is ignored, and
the node cli must be used to change the password.
The password specified must be at least 8 characters in length and must
contain at least one lowercase, one uppercase, one numeric character and one
special character (except quotes).
string Pattern: "^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[~`!@#$%^&*)(\-_\+\=}{\]\[|:;,?\.><])[A-Za-z\d~`!@#$%^&*)(\-_\+\=}{\]\[\|:;,?\.><]{8,}$"
cli_username CLI "admin" username

To configure username, you must provide this property together with
cli_password.
string Default: "admin"
root_password Node root user password

Password for the node root user. For deployment,
this property is required. After deployment, this property is ignored, and
the node cli must be used to change the password.
The password specified must be at least 8 characters in length and must
contain at least one lowercase, one uppercase, one numeric character and one
special character (except quotes).
string Pattern: "^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[~`!@#$%^&*)(\-_\+\=}{\]\[|:;,?\.><])[A-Za-z\d~`!@#$%^&*)(\-_\+\=}{\]\[\|:;,?\.><]{8,}$"

NodeVersion (schema)

Name Description Type Notes
node_version Node version string Readonly
product_version Product version string Readonly

NormalizationListRequestParameters (schema)

Normalization list request parameters.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
preferred_normalization_type Type to which the resource is to be normalized.

Type to which the resource needs to be normalized. Multiple types
can be passed by repeating the parameter. The order in which the
types are passed is honored and decides to which type the resource is
normalized. The resource is normalized to the first type in the list
to which it can be normalized.

For example, consider an NSGroup NS1 that has an LSwitch LS1. Assume
that NS1 is being normalized to a list of translated entities
[LSwitch, LPort]. As LSwitch is the first translated entity to which
NSGroup can be translated, the translation will return a list having
the LSwitch LS1.

Normalization is supported from NSGroup to NSGroup, LogicalSwitch,
LogicalPort, IPSets and MACSets.
NormalizationTargetType Required
resource_id Identifier of the resource on which normalization is to be performed string Required
resource_type Type of the resource for which normalization is to be performed NormalizationSourceType Required
sort_ascending boolean
sort_by Field by which records are sorted string

NormalizationSourceType (schema)

Resource type valid for use as source in normalization API.

Name Description Type Notes
NormalizationSourceType Resource type valid for use as source in normalization API. string Enum: NSGroup

NormalizationTargetType (schema)

Resource type valid for use as target in normalization API.

Name Description Type Notes
NormalizationTargetType Resource type valid for use as target in normalization API. string Enum: NSGroup, IPSet, MACSet, LogicalSwitch, LogicalPort, DirectoryGroup

NormalizedResourceListResult (schema)

Paged Collection of normalized resources

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Normalized resource list results array of ResourceReference Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NsxManagerAccount (schema)

NSX Manager Account Structure

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
fqdn Fully Qualified Domain Name string
id Unique identifier of this resource string Readonly
Sortable
password Password of the NSX Manager Account string
private_ip Private IP Address of the NSX Manager Account string
public_ip Public IP Address of the NSX Manager Account string
resource_type Must be set to the value NsxManagerAccount string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tenant_id Tenant ID of the NSX Manager account string
thumbprint Thumb print of the NSX Manager Account string
token One time access token for Nsx Manager registration

This field can be used for using one time access token for Nsx Manager
registration.
string
username Username of the NSX Manager Account string Required

NsxManagerAccountsListResult (schema)

NSX Manager Accounts list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results NSX Manager Accounts list array of NsxManagerAccount
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

NsxRole (schema)

Role

Name Description Type Notes
permissions Permissions

Please use the /user-info/permissions api to get the permission that the user has on each feature.		 array of string Deprecated
role Role name string Required
Enum: read_only_api_users, read_write_api_users, enterprise_admin, auditor, network_engineer, network_op, security_engineer, security_op, lb_admin, lb_auditor, cloud_service_admin, cloud_service_auditor, site_reliability_engineer, site_reliability_auditor, cloud_admin, cloud_auditor

NtpServiceProperties (schema)

NTP Service properties

Name Description Type Notes
servers NTP servers array of HostnameOrIPv4Address Required

Oauth2Credentials (schema)

Oauth2 Account Credentials

Name Description Type Notes
client_id Client ID

Client ID, that will be used for authentication in AWS environment,		 string Required
client_secret Client Secret

Client secret, that will be used for authentication in AWS environment. Can be some passphrase.		 string Required

OrgInfo (schema)

Organization ID and role

Organization ID and role, predefined for a particular type of VMware support.

Name Description Type Notes
org_id Org ID

Organization ID, connected to a predefined role of a VMware support.		 string Required
org_role Org role

Predefined role of a VMware support.		 string Required

OwnerResourceLink (schema)

Link to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.

Name Description Type Notes
action Optional action string Readonly
href Link to resource string Required
Readonly
rel Link relation type

Custom relation type (follows RFC 5988 where appropriate definitions exist)		 string Required
Readonly

PBRListRequestParameters (schema)

Parameters to filter list of sections/rules

Pagination and Filtering parameters to get only a subset of sections/rules.

Name Description Type Notes
applied_tos AppliedTo's referenced by this section or section's Distributed Service Rules .

Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
destinations Destinations referenced by this section's Distributed Service Rules .

The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
filter_type Filter type

Filter type defines matching criteria to qualify a rule in result. Type
'FILTER' will ensure all criterias (sources, destinations, services,
appliedtos) are matched. Type 'SEARCH' will match any of the given
criteria.
string Enum: FILTER, SEARCH
Default: "FILTER"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
services NSService referenced by this section's Distributed Service Rules .

Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
sort_ascending boolean
sort_by Field by which records are sorted string
sources Sources referenced by this section's Distributed Service Rules .

The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string

PBRRule (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_owner Owner of this resource OwnerResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
action Action

Action enforced on the packets which matches the PBR rule.		 string Required
Enum: ROUTE_TO_UNDERLAY_NAT, ROUTE_TO_OVERLAY_NAT, ROUTE_TO_UNDERLAY, ROUTE_TO_OVERLAY
applied_tos AppliedTo List

List of object where rule will be enforced. field overrides this one. Null will be treated as any.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
destinations Destination List

List of the destinations. Null will be treated as any.		 array of ResourceReference Maximum items: 128
disabled Rule enable/disable flag

Flag to disable rule. Disabled will only be persisted but never provisioned/realized.		 boolean Default: "False"
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Identifier of the resource string Readonly
logged Enable logging flag

Flag to enable packet logging. Default is disabled.		 boolean Default: "False"
notes Notes

User notes specific to the rule.		 string Maximum length: 2048
resource_type Must be set to the value PBRRule string
rule_tag Tag

User level field which will be printed in CLI and packet logs.		 string Maximum length: 32
services Service List

List of the services. Null will be treated as any.		 array of PBRService Maximum items: 128
sources Source List

List of sources. Null will be treated as any.		 array of ResourceReference Maximum items: 128

PBRRuleListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results PBR rule list result

PBR rule list result with pagination support.		 array of PBRRule Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

PBRSection (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value PBRSection string
rule_count Rule count

Number of rules in this section.		 integer Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

PBRSectionFilterParameters (schema)

Parameters to filter section from list of sections

Pagination and Filtering parameters to get only a subset of sections.

Name Description Type Notes
applied_tos AppliedTo's referenced by this section or section's Distributed Service Rules .

Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
destinations Destinations referenced by this section's Distributed Service Rules .

The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
exclude_applied_to_type Limit result to sections not having a specific AppliedTo type

Used to filter out sections not having a specified AppliedTo target type. This parameter cannot be used along with include_applied_to_type parameter. Section filter only takes a single value for this param.		 DSAppliedToType
filter_type Filter type

Filter type defines matching criteria to qualify a rule in result. Type
'FILTER' will ensure all criterias (sources, destinations, services,
appliedtos) are matched. Type 'SEARCH' will match any of the given
criteria.
string Enum: FILTER, SEARCH
Default: "FILTER"
include_applied_to_type Limit result to sections having a specific AppliedTo type

Used to filter out results based on target type of a section's AppliedTo. Only sections with matching target type in its applied to will be returned. This parameter cannot be used along with exclude_applied_to_type parameter.Section filter only takes a single value for this param.		 DSAppliedToType
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
services NSService referenced by this section's Distributed Service Rules .

Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
sort_ascending boolean
sort_by Field by which records are sorted string
sources Sources referenced by this section's Distributed Service Rules .

The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string

PBRSectionListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Section list

List of the PBR sections.		 array of PBRSection Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

PBRSectionRuleList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value PBRSectionRuleList string
rule_count Rule count

Number of rules in this section.		 integer Readonly
rules List of the PBR rules

List of PBR rules in the section.		 array of PBRRule Required
Maximum items: 1000
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

PBRService (schema)

PBR Service element

Type to define services associated with every rule

Name Description Type Notes
is_valid Target validity

Will be set to false if the referenced NSX resource has been deleted.		 boolean Readonly
service Distributed Service Network and Security Service element

Distributed Service API accepts raw protocol and ports as part of NS service element
in Distributed Service Rule that describes traffic corresponding to an NSService.
NSServiceElement
(Abstract type: pass one of the following concrete types)
ALGTypeNSService
EtherTypeNSService
ICMPTypeNSService
IGMPTypeNSService
IPProtocolNSService
L4PortSetNSService
target_display_name Target display name

Display name of the NSX resource.		 string Readonly
Maximum length: 255
target_id Target ID

Identifier of the NSX resource.		 string Maximum length: 64
target_type Target type

Type of the NSX resource.		 string Maximum length: 255

PackageStore (schema)

Contains package information

Name Description Type Notes
bulletin_ids List of bulletin ids array of string Required
package_url url of the package string Required

PacketAddressClassifier (schema)

Address classifications for a packet

A packet is classified to have an address binding, if its address
configuration matches with all user specified properties.

Name Description Type Notes
ip_address A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y IPElement
mac_address A single MAC address MACAddress
vlan VlanID

PacketCaptureOption (schema)

Packet capture option

The option is used to filter data on given node.

Name Description Type Notes
name Packet capture option name

The avaiable option names in the enum can be used to filter the capture data.		 string Enum: ETHTYPE, MAC, SRCMAC, DSTMAC, VLAN, IP, SRCIP, DSTIP, IPPROTO, PORT, SRCPORT, DSTPORT, VNI
value Packet capture option value

Define the capture value according to the given capture option.		 string

PacketCaptureOptionList (schema)

List of packet capture options

List of packet capture options to filter data in capture process.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly
values Packet capture option collection

Packet capture option collection		 array of PacketCaptureOption

PacketCaptureRequest (schema)

Packet capture request information

This type is used to create packet request on give node. Need to specify related parameters according to the capture point.

Name Description Type Notes
capamount Packet capture amount

Define the packet capture amount size.		 int
capduration Packet capture duration time in seconds

Define the packet capture duration time. After the capture duration time, the capture process will stop working.		 int
capfilesize Packet capture file size limit

Define the packet capture file size limit.		 int
capmode Packet Capture streaming mode

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.		 string Enum: STANDALONE, STREAM
cappoint Packet capture point

Define the point to capture data.		 string Required
Enum: VNIC, VMKNIC, VMNIC, VDRPORT, DVFILTER, LOGICALPORT, VIF
caprate Packet capture rate

Define the rate of packet capture process.		 int
capsource Packet capture source type

This type is used to differenite the incoming request from CLI/UI.		 string Required
Enum: CLI, UI
capvalue Packet capture point value

Define the capture value of given capture point.		 string
direction Packet capture direction type

Define the capture direction. Support three types INPUT/OUTPUT/DUAL.		 string Enum: INPUT, OUTPUT, DUAL
filtertype Packet capture dvfilter stage type

Define the capture filter type. Support PRE/POST mode.		 string Enum: PRE, POST
node Packet capture node id

Define the transport node to capture data.		 string
options Packet capture options

Define the packet capture additional options to filter the capture data.		 PacketCaptureOptionList
streamaddress Packet capture Streaming address

Set the stream address to receive the capture packet.		 string
streamport Packet capture Streaming port

Set the stream port to receive the capture packet.		 int

PacketCaptureSession (schema)

Packet capture response information

Name Description Type Notes
endtime Timestamp when session was stopped in epoch millisecond EpochMsTimestamp
errormsg Error messasge in capture string
filelocation Packet capture file location string
filesize Packet capture file Size in bytes int
request Packet capture request PacketCaptureRequest Required
sessionid Packet capture session id string Required
sessionname Packet capture session name string
sessionstatus Packet capture session status string Required
Enum: CREATED, STARTED, STOPPED, FINISHED, ERROR
starttime Timestamp when session was created in epoch millisecond EpochMsTimestamp

PacketCaptureSessionList (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Total capture session count integer Required
results Packet capture list for all sessoins array of PacketCaptureSession
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

PasswordAuthenticationScheme (schema)

Name Description Type Notes
password Password to authenticate with string Required
scheme_name Authentication scheme name string Required
Enum: password
username User name to authenticate with string Required
Pattern: "^.+$"

PemFile (schema)

Name Description Type Notes
file file data multipart_file Required

PerStepRestoreStatus (schema)

Restore step status

Name Description Type Notes
description A description of the restore status string Required
Readonly
value Per step restore status value string Required
Readonly
Enum: INITIAL, RUNNING, SUSPENDED_BY_USER, SUSPENDED_FOR_USER_ACTION, FAILED, SUCCESS

PersistenceProfileType (schema)

persistence profile type

Source-ip persistence ensures all connections from a client (identified by
IP address) are sent to the same backend server for a specified period.
Cookie persistence allows related client connections, identified by the
same cookie in HTTP requests, to be redirected to the same server.

Name Description Type Notes
PersistenceProfileType persistence profile type

Source-ip persistence ensures all connections from a client (identified by
IP address) are sent to the same backend server for a specified period.
Cookie persistence allows related client connections, identified by the
same cookie in HTTP requests, to be redirected to the same server.
string Enum: LbCookiePersistenceProfile, LbSourceIpPersistenceProfile

Pnic (schema)

Physical NIC specification

Name Description Type Notes
device_name device name or key string Required
uplink_name Uplink name for this Pnic. This name will be used to reference this Pnic in other configurations. string Required

PnicBondStatus (schema)

pNIC/bond status

pNIC/bond statuses

Name Description Type Notes
name pNIC/bond name

Name of the pNIC/bond		 string
status pNic/bond status

Status of pNIC/bond		 string Enum: UNKNOWN, UP, DOWN, DEGRADED
type Object type

type, whether the object is a pNIC or a bond		 string Enum: UNKNOWN_TYPE, PNIC, BOND

PnicBondStatusListResult (schema)

pNIC status list container

This object contains reference to list of pNIC/bond statuses

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of pNIC/bond statuses

List of pNIC statuses belonging to the transport node		 array of PnicBondStatus
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

PnicMirrorDestination (schema)

Name Description Type Notes
dest_pnics Physical NIC device names to which to send the mirrored packets array of string Required
Minimum items: 1
Maximum items: 3
node_id Transport node to which to send the mirrored packets string Required
resource_type Must be set to the value PnicMirrorDestination MirrorDestinationResourceType Required

PnicMirrorSource (schema)

Name Description Type Notes
encapsulated Whether to filter encapsulated packet. boolean Required
Default: "False"
node_id Transport node identifier for the pnic located. string Required
resource_type Must be set to the value PnicMirrorSource MirrorSourceResourceType Required
source_pnics Source physical NIC device names array of string Required

PolicyBasedIPSecVPNSession (schema)

Policy based VPN session

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enable/Disable IPSec VPN session

Enable/Disable IPSec VPN session.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
ipsec_vpn_service_id IPSec VPN service identifier

Identifier of VPN Service linked with local endpoint.		 string Readonly
local_endpoint_id Local endpoint identifier

Local endpoint identifier.		 string Required
peer_endpoint_id Peer endpoint identifier

Peer endpoint identifier.		 string Required
policy_rules Policy rules array of IPSecVPNPolicyRule Required
resource_type Must be set to the value PolicyBasedIPSecVPNSession IPSecVPNSessionResourceType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

PoolAlgorithm (schema)

load balancing algorithm

Load Balancing algorithm chooses a server for each new connection by going
through the list of servers in the pool. Currently, following load balancing
algorithms are supported with ROUND_ROBIN as the default.
ROUND_ROBIN means that a server is selected in a round-robin fashion. The
weight would be ignored even if it is configured.
WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted
round-robin fashion. Default weight of 1 is used if weight is not configured.
LEAST_CONNECTION means that a server is selected when it has the least
number of connections. The weight would be ignored even if it is configured.
Slow start would be enabled by default.
WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted
least connection fashion. Default weight of 1 is used if weight is not
configured. Slow start would be enabled by default.
IP_HASH means that consistent hash is performed on the source IP address of
the incoming connection. This ensures that the same client IP address will
always reach the same server as long as no server goes down or up. It may
be used on the Internet to provide a best-effort stickiness to clients
which refuse session cookies.

Name Description Type Notes
PoolAlgorithm load balancing algorithm

Load Balancing algorithm chooses a server for each new connection by going
through the list of servers in the pool. Currently, following load balancing
algorithms are supported with ROUND_ROBIN as the default.
ROUND_ROBIN means that a server is selected in a round-robin fashion. The
weight would be ignored even if it is configured.
WEIGHTED_ROUND_ROBIN means that a server is selected in a weighted
round-robin fashion. Default weight of 1 is used if weight is not configured.
LEAST_CONNECTION means that a server is selected when it has the least
number of connections. The weight would be ignored even if it is configured.
Slow start would be enabled by default.
WEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted
least connection fashion. Default weight of 1 is used if weight is not
configured. Slow start would be enabled by default.
IP_HASH means that consistent hash is performed on the source IP address of
the incoming connection. This ensures that the same client IP address will
always reach the same server as long as no server goes down or up. It may
be used on the Internet to provide a best-effort stickiness to clients
which refuse session cookies.
string Enum: ROUND_ROBIN, WEIGHTED_ROUND_ROBIN, LEAST_CONNECTION, WEIGHTED_LEAST_CONNECTION, IP_HASH

PoolMember (schema)

Name Description Type Notes
admin_state member admin state PoolMemberAdminStateType Default: "ENABLED"
backup_member determine whether the pool member is for backup usage

Backup servers are typically configured with a sorry page indicating to
the user that the application is currently unavailable. While the pool
is active (a specified minimum number of pool members are active)
BACKUP members are skipped during server selection. When the pool is
inactive, incoming connections are sent to only the BACKUP member(s).
boolean Default: "False"
display_name pool member name string
ip_address pool member IP address IPAddress Required
max_concurrent_connections maximum concurrent connection number

To ensure members are not overloaded, connections to a member can be
capped by the load balancer. When a member reaches this limit, it is
skipped during server selection.
If it is not specified, it means that connections are unlimited.
integer Minimum: 1
Maximum: 2147483647
port pool member port number

If port is specified, all connections will be sent to this port. Only
single port is supported.
If unset, the same port the client connected to will be used, it could
be overrode by default_pool_member_port setting in virtual server.
The port should not specified for port range case.
PortElement
weight pool member weight

Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing
algorithm. The weight value would be ignored in other algorithms.
integer Minimum: 1
Maximum: 256
Default: "1"

PoolMemberAdminStateType (schema)

pool member admin state

User can set the admin state of a member to ENABLED or DISABLED or
GRACEFUL_DISABLED. By default, when a member is added, it is ENABLED.
If a member is set to DISABLED, it is not selected for any new
connections. Active connections, however, will continue to be processed
by it. New connections with matching persistence entries pointing to
DISABLED members are not sent to those DISABLED members. Those connections
are assigned to other members of the pool and the corresponding persistence
entries are updated to point to the newly selected server.
To allow for a more graceful way of taking down servers for maintenance, a
routine task, another admin state GRACEFUL_DISABLED is supported. Existing
connections to a member in GRACEFUL_DISABLED state continue to be processed.

Name Description Type Notes
PoolMemberAdminStateType pool member admin state

User can set the admin state of a member to ENABLED or DISABLED or
GRACEFUL_DISABLED. By default, when a member is added, it is ENABLED.
If a member is set to DISABLED, it is not selected for any new
connections. Active connections, however, will continue to be processed
by it. New connections with matching persistence entries pointing to
DISABLED members are not sent to those DISABLED members. Those connections
are assigned to other members of the pool and the corresponding persistence
entries are updated to point to the newly selected server.
To allow for a more graceful way of taking down servers for maintenance, a
routine task, another admin state GRACEFUL_DISABLED is supported. Existing
connections to a member in GRACEFUL_DISABLED state continue to be processed.
string Enum: ENABLED, DISABLED, GRACEFUL_DISABLED

PoolMemberGroup (schema)

Name Description Type Notes
customized_members List of customized pool member settings

The list is used to show the customized pool member settings. User can
only user pool member action API to update the admin state for a specific
IP address.
array of PoolMemberSetting
grouping_object Grouping object resource reference

Load balancer pool support grouping object as dynamic pool members.
The IP list of the grouping object such as NSGroup would be used as
pool member IP setting.
ResourceReference Required
ip_revision_filter Filter of ipv4 or ipv6 address of grouping object IP list

Ip revision filter is used to filter IPv4 or IPv6 addresses from the
grouping object.
If the filter is not specified, both IPv4 and IPv6 addresses would be
used as server IPs.
The link local and loopback addresses would be always filtered out.
string Enum: IPV4, IPV6, IPV4_IPV6
Default: "IPV4"
max_ip_list_size Maximum number of grouping object IP address list

The size is used to define the maximum number of grouping object IP
address list. These IP addresses would be used as pool members.
If the grouping object includes more than certain number of
IP addresses, the redundant parts would be ignored and those IP
addresses would not be treated as pool members.
If the size is not specified, one member is budgeted for this dynamic
pool so that the pool has at least one member even if some other
dynamic pools grow beyond the capacity of load balancer service. Other
members are picked according to available dynamic capacity. The unused
members would be set to DISABLED so that the load balancer system
itself is not overloaded during runtime.
integer Minimum: 0
Maximum: 2147483647
port Pool member port for all IP addresses of the grouping object

If port is specified, all connections will be sent to this port.
If unset, the same port the client connected to will be used, it could
be overridden by default_pool_member_ports setting in virtual server.
The port should not specified for multiple ports case.
int Minimum: 1
Maximum: 65535

PoolMemberSetting (schema)

Pool member setting

The setting is used to add, update or remove pool members from pool.
For static pool members, admin_state, display_name and weight can be
updated.
For dynamic pool members, only admin_state can be updated.

Name Description Type Notes
admin_state Member admin state PoolMemberAdminStateType Default: "ENABLED"
display_name Pool member display name

Only applicable to static pool members. If supplied for a pool defined
by a grouping object, update API would fail.
string
ip_address Pool member IP address IPAddress Required
port Pool member port number PortElement
weight Pool member weight

Only applicable to static pool members. If supplied for a pool defined
by a grouping object, update API would fail.
integer Minimum: 1
Maximum: 255

PoolUsage (schema)

Pool usage statistics in a pool.

Name Description Type Notes
allocated_ids Total number of allocated IDs in a pool integer Readonly
free_ids Total number of free IDs in a pool integer Readonly
total_ids Total number of IDs in a pool integer Readonly

PortElement (schema)

A port or a port range

Examples- Single port "8080", Range of ports "8090-8095"

Name Description Type Notes
PortElement A port or a port range

Examples- Single port "8080", Range of ports "8090-8095"
string

PortMirroringSession (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
direction Port mirroring session direction DirectionType Required
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
encapsulation_vlan_id Encapsulation VLAN ID

Only for Remote SPAN Port Mirror.		 VlanID
id Unique identifier of this resource string Readonly
Sortable
mirror_destination Mirror destination MirrorDestination
(Abstract type: pass one of the following concrete types)
IPMirrorDestination
LogicalPortMirrorDestination
PnicMirrorDestination		 Required
mirror_sources Mirror sources array of MirrorSource
(Abstract type: pass one of the following concrete types)
LogicalPortMirrorSource
LogicalSwitchMirrorSource
PnicMirrorSource
VlanMirrorSource		 Required
Minimum items: 1
Maximum items: 6
preserve_original_vlan Only for Remote SPAN Port Mirror. Whether to preserve original VLAN. boolean Default: "False"
resource_type Must be set to the value PortMirroringSession string
session_type Port mirroring session type

If this property is unset, this session will be treated as
LocalPortMirrorSession.
PortMirroringSessionType Default: "LocalPortMirrorSession"
snap_length Maximum packet length for packet truncation

If this property is set, the packet will be truncated to the provided
length. If this property is unset, entire packet will be mirrored.
integer Minimum: 60
Maximum: 65535
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

PortMirroringSessionListResult (schema)

Mirror session queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Port mirroring session results array of PortMirroringSession Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

PortMirroringSessionType (schema)

Resource types of mirror session

PortMirroringSession is the configuration instance of port mirroring, you can
create different types of PortMirroringSession with different mirror source
and mirror destination.
Each port mirror session type has its own mirror source and mirror destination pair.
LocalPortMirrorSession include LogicalPortMirrorSession and UplinkPortMirrorSession.
You can create multiple mirror sessions of same parent type by one API call.
LogicalPortMirrorSession
- source[LogicalPortMirrorSource] destination[LogicalPortMirrorDestination]
UplinkPortMirrorSession
- source[PnicMirrorSource] destination[LogicalPortMirrorDestination]
RspanSrcMirrorSession
- source[LogicalPortMirrorSource] destination[PnicMirrorDestination]
RspanDstMirrorSession
- source[VlanMirrorSource] destination[LogicalPortMirrorDestination]
LogicalLocalPortMirrorSession
- source[LogicalPortMirrorSource] destination[LogicalPortMirrorDestination]
L3PortMirrorSession
- source[LogicalPortMirrorSource] destination[IPMirrorDestination]

Name Description Type Notes
PortMirroringSessionType Resource types of mirror session

PortMirroringSession is the configuration instance of port mirroring, you can
create different types of PortMirroringSession with different mirror source
and mirror destination.
Each port mirror session type has its own mirror source and mirror destination pair.
LocalPortMirrorSession include LogicalPortMirrorSession and UplinkPortMirrorSession.
You can create multiple mirror sessions of same parent type by one API call.
LogicalPortMirrorSession
- source[LogicalPortMirrorSource] destination[LogicalPortMirrorDestination]
UplinkPortMirrorSession
- source[PnicMirrorSource] destination[LogicalPortMirrorDestination]
RspanSrcMirrorSession
- source[LogicalPortMirrorSource] destination[PnicMirrorDestination]
RspanDstMirrorSession
- source[VlanMirrorSource] destination[LogicalPortMirrorDestination]
LogicalLocalPortMirrorSession
- source[LogicalPortMirrorSource] destination[LogicalPortMirrorDestination]
L3PortMirrorSession
- source[LogicalPortMirrorSource] destination[IPMirrorDestination]
string Enum: LogicalPortMirrorSession, UplinkPortMirrorSession, RspanSrcMirrorSession, RspanDstMirrorSession, LocalPortMirrorSession, LogicalLocalPortMirrorSession, L3PortMirrorSession

PortMirroringSwitchingProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
destinations List of destination addresses array of IPAddress Maximum items: 3
direction DirectionType
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
key User-configurable 32-bit key integer
required_capabilities array of string Readonly
resource_type Must be set to the value PortMirroringSwitchingProfile string Required
snap_length Snap length for package truncation

If this property not set, original package will not be truncated.		 integer Minimum: 60
Maximum: 65535
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

PortStatus (schema)

indicates if the RabbitMQ management port is set or not

Name Description Type Notes
enabled indicates if the RabbitMQ management port is set or not boolean Required

PreconfiguredEndpoint (schema)

Tunnel endpoint configuration of preconfigured host switch

Name Description Type Notes
device_name Name of the virtual tunnel endpoint string Required

PreconfiguredHostSwitch (schema)

Preconfigured host switch

Preconfigured host switch is used for manually configured transport node.

Name Description Type Notes
endpoints List of virtual tunnel endpoints which are preconfigured on this host switch array of PreconfiguredEndpoint Maximum items: 1
host_switch_id External Id of the preconfigured host switch. string Required

PreconfiguredHostSwitchSpec (schema)

Specification of transport node preconfigured host switch

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.

Name Description Type Notes
host_switches Preconfigured Transport Node host switches array of PreconfiguredHostSwitch Required
Maximum items: 1
resource_type Must be set to the value PreconfiguredHostSwitchSpec string Required
Enum: StandardHostSwitchSpec, PreconfiguredHostSwitchSpec

PrefixConfig (schema)

Name Description Type Notes
action Action for the IPPrefix RoutingFilterAction Required
ge Greater than or equal to integer Minimum: 1
Maximum: 32
le Less than or equal to integer Minimum: 1
Maximum: 32
network CIDR

If absent, the action applies to all addresses.		 IPv4CIDRBlock

Principal (schema)

Name Description Type Notes
attributes Certificate list array of KeyValue Required

PrincipalIdentity (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
certificate_id Id of the stored certificate

Id of the stored certificate		 string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_protected Protection indicator

Indicator whether the entities created by this principal should be protected		 boolean
name Name

Name of the principal		 string Required
Maximum length: 255
Pattern: "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$"
node_id Unique node-id

Unique node-id of a principal		 string Required
Maximum length: 255
Pattern: "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$"
permission_group permission group

Use the 'role' field instead and pass in 'auditor' for read_only_api_users or 'enterprise_admin' for the others.		 UserGroupType Deprecated
resource_type Must be set to the value PrincipalIdentity string
role Role string Pattern: "^[a-zA-Z]+(_?[a-zA-Z]+)*$"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

PrincipalIdentityList (schema)

PrincipalIdentity query result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results PrincipalIdentity list array of PrincipalIdentity Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

PropertyItem (schema)

LabelValue Property

Represents a label-value pair.

Name Description Type Notes
condition Expression for evaluating condition

If the condition is met then the property will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.		 string Maximum length: 1024
field Field of the Property

Represents field value of the property.		 string Required
Maximum length: 1024
heading If true, represents the field as a heading

Set to true if the field is a heading. Default is false.		 boolean Default: "False"
label Label of the property

If a field represents a heading, then label is not needed		 Label
render_configuration Render Configuration

Render configuration to be applied, if any.		 array of RenderConfiguration
type field data type

Data type of the field.		 string Required
Enum: String, Number, Date, Url
Maximum length: 255
Default: "String"

Protocol (schema)

This is an abstract type. Concrete child types:
HttpProtocol
HttpsProtocol
ScpProtocol
SftpProtocol

Name Description Type Notes
name Protocol name string Required
Enum: http, https, scp, sftp

ProtocolVersion (schema)

HTTP protocol version

Name Description Type Notes
enabled Enable status for this protocol version boolean Required
name Name of the TLS protocol version string Required

ProtonPackageLoggingLevels (schema)

Name Description Type Notes
logging_level Logging levels per package string Enum: ERROR, WARN, INFO, DEBUG, TRACE
package_name Package name string

ProtonServiceProperties (schema)

Service properties

Name Description Type Notes
logging_level Service logging level string Required
Enum: ERROR, WARN, INFO, DEBUG, TRACE
package_logging_level Package logging levels array of ProtonPackageLoggingLevels

ProxyServerProfileInfo (schema)

Proxy Server Profile Information

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
host IP Address or name of the proxy server

IP Address or name of the proxy server.
string Required
id Unique identifier of this resource string Readonly
Sortable
is_default Flag to decide default proxy profile

Flag which decides whether current proxy server profile
is default or not.
boolean Default: "False"
password Password of the proxy server

The Password for the proxy server.
string
port Port of the proxy server

The port of the proxy server.
integer Required
profilename Name of the proxy profile

The name of proxy profile.
string Required
resource_type Must be set to the value ProxyServerProfileInfo string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tls_certificate TLS certificate of Proxy Server

If proxy server is using TLS certificate for secure
communication. In that case, certificate of Proxy Server
is required.
string
username Username of the proxy server

The username for the proxy server.
string

ProxyServerProfilesListResult (schema)

Proxy Server Profiles list

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Proxy Server Profile list array of ProxyServerProfileInfo
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

PublicCloudGatewayNode (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
allocation_list Allocation list

List of logical router ids to which this edge node is allocated.		 array of string Readonly
deployment_config Config for automatic deployment of edge node virtual machine.

When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE
will be deployed and registered with MP.
EdgeNodeDeploymentConfig
deployment_type EdgeDeploymentType Readonly
description Description of this resource string Maximum length: 1024
Sortable
discovered_ip_addresses Discovered IP Addresses of the fabric node, version 4 or 6 array of IPAddress Readonly
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id ID of the Node maintained on the Node and used to recognize the Node string
fqdn Fully qualified domain name of the fabric node string Readonly
id Unique identifier of this resource string Readonly
Sortable
ip_addresses IP Addresses of the Node, version 4 or 6

IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for
automatic deployment of edge virtual machine node. For automatic deployment, the ip address from
management_port_subnets property will be considered.
array of IPAddress
resource_type Must be set to the value PublicCloudGatewayNode string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

QosBaseRateShaper (schema)

A shaper configuration entry that specifies type and metrics

Name Description Type Notes
enabled boolean Required
resource_type string Enum: IngressRateShaper, IngressBroadcastRateShaper, EgressRateShaper
Default: "IngressRateShaper"

QosSwitchingProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
class_of_service Class of service int Minimum: 0
Maximum: 7
Default: "0"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
dscp Dscp
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value QosSwitchingProfile string Required
shaper_configuration array of QosBaseRateShaper Minimum items: 0
Maximum items: 3
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

QueryTunnelParameters (schema)

Name Description Type Notes
bfd_diagnostic_code BFD diagnostic code of Tunnel as defined in RFC 5880 string 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
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
remote_node_id string
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
status Tunnel status string Enum: UP, DOWN

QuickSearchResponse (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
result_count Result count integer Required
results Search results array of TypeGroup Required

RateLimits (schema)

Rate limiting configuration

Enables traffic limit for incoming/outgoing broadcast and multicast packets. Use 0 to disable rate limiting for a specific traffic type

Name Description Type Notes
enabled Whether rate limiting is enabled boolean Default: "False"
rx_broadcast Incoming broadcast traffic limit in packets per second int Minimum: 0
Default: "0"
rx_multicast Incoming multicast traffic limit in packets per second int Minimum: 0
Default: "0"
tx_broadcast Outgoing broadcast traffic limit in packets per second int Minimum: 0
Default: "0"
tx_multicast Outgoing multicast traffic limit in packets per second int Minimum: 0
Default: "0"

RealizationStateBarrierConfig (schema)

The configuration data for setting the global realization state barrier

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
interval Interval in milliseconds

The interval in milliseconds used for auto incrementing the barrier number
integer Required
Minimum: 0

RedistributionConfig (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
bgp_enabled Flag to enable redistribution for BGP as destinationProtocol boolean Default: "False"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value RedistributionConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

RedistributionProtocols (schema)

Redistribution Protocols

Types of route to redistribute over routing protocols.
STATIC type should be used to redistribute user added static
routes.
NSX_CONNECTED type should be used to redistribute downlink port
subnets.
NSX_STATIC type should be used to redistribute nsx-connected and
static routes advertised by TIER1 logical router.
TIER0_NAT type should be used to redistribute NAT IPs owned by
TIER0 logical router.
TIER1_NAT type should be used to redistribute NAT IPs advertised
by TIER1 logical router.
TIER1_LB_VIP type should be used to redistribute LB VIP IPs
advertised by TIER1 logical router.
TIER1_LB_SNAT type should be used to redistribute LB SNAT IPs
advertised by TIER1 logical router.
BGP type should be used to redistribute routes learned via BGP.

Name Description Type Notes
RedistributionProtocols Redistribution Protocols

Types of route to redistribute over routing protocols.
STATIC type should be used to redistribute user added static
routes.
NSX_CONNECTED type should be used to redistribute downlink port
subnets.
NSX_STATIC type should be used to redistribute nsx-connected and
static routes advertised by TIER1 logical router.
TIER0_NAT type should be used to redistribute NAT IPs owned by
TIER0 logical router.
TIER1_NAT type should be used to redistribute NAT IPs advertised
by TIER1 logical router.
TIER1_LB_VIP type should be used to redistribute LB VIP IPs
advertised by TIER1 logical router.
TIER1_LB_SNAT type should be used to redistribute LB SNAT IPs
advertised by TIER1 logical router.
BGP type should be used to redistribute routes learned via BGP.
string Enum: STATIC, NSX_CONNECTED, NSX_STATIC, TIER0_NAT, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, BGP

RedistributionRule (schema)

Name Description Type Notes
description Description string Maximum length: 1024
destination Destination redistribution protocol RedistributionProtocols Required
display_name Display name string Maximum length: 255
route_map_id RouteMap Id for the filter string
sources Array of redistribution protocols array of RedistributionProtocols Required

RedistributionRuleList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value RedistributionRuleList string
rules List of redistribution rules. User needs to re-order rules to change the priority. array of RedistributionRule Minimum items: 0
Maximum items: 5
Default: "[]"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

RegistrationToken (schema)

Appliance registration access token

Name Description Type Notes
roles List results array of string Required
token Access token string Required

RelatedApiError (schema)

Detailed information about a related API error

Name Description Type Notes
details Further details about the error string
error_code A numeric error code integer
error_data Additional data about the error object
error_message A description of the error string
module_name The module name where the error occurred string

RelatedData (schema)

Related object details

The results array will contain all the related objects

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
alias Alias

Alias for the related type		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Related objects

Array of related objects		 array of object Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

RelatedDataRequest (schema)

Related object request

Request parameters for the related types

Name Description Type Notes
alias Alias

Alias for the response		 string
filters Filter conditions

An array of filter conditions		 array of FilterRequest
included_fields Comma separated list of fields that should be included in query result string
join_condition Join condition

Join condition between the parent and the related object.
This is to be specified in "relatedObjectFieldName:ParentObjectFieldName" format.
string Required
resource_type Resource Type

Resource type name		 string Required
size Size

Number of related objects to return.
If not specified all the related objects will be returned.
Should be set to 0 if only the count of related objects is desired.
integer

RemainingSupportBundleNode (schema)

Name Description Type Notes
node_display_name Display name of node string Required
Readonly
node_id UUID of node string Required
Readonly
status Status of node string Required
Readonly
Enum: PENDING, PROCESSING

RemoteFileServer (schema)

Remote file server

Name Description Type Notes
directory_path Remote server directory to copy bundle files to string Required
Pattern: "^\/[\w\-.\+~%\/]+$"
port Server port integer Minimum: 1
Maximum: 65535
Default: "22"
protocol Protocol to use to copy file FileTransferProtocol Required
server Remote server hostname or IP address string Required

RemoteServerFingerprint (schema)

Remote server

Name Description Type Notes
port Server port integer Minimum: 1
Maximum: 65535
Default: "22"
server Remote server hostname or IP address string Required
ssh_fingerprint SSH fingerprint of server string Required

RemoteServerFingerprintRequest (schema)

Remote server

Name Description Type Notes
port Server port integer Minimum: 1
Maximum: 65535
Default: "22"
server Remote server hostname or IP address string Required

RemoteTransportNodeStatusParametersWithDataSource (schema)

Query parameters that may be used to select which transport nodes status to return in a query.
The tunnel_status and bfd_diagnostic_code parameters are ANDed together if both are provided.

Name Description Type Notes
bfd_diagnostic_code BFD diagnostic code of Tunnel as defined in RFC 5880

If specified, only the status for transport nodes connected via tunnels having the
specified BFD diagnostic code are returned.
string 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
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
tunnel_status Tunnel Status

If specified, only the status for transport nodes connected via tunnels having the
specified tunnel status are returned.
string Enum: UP, DOWN

RenderConfiguration (schema)

Render Configuration

Render configuration to be applied to the widget.

Name Description Type Notes
color Color of the entity

The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.		 string Enum: GREY, SKY_BLUE, BLUE, GREEN, YELLOW, RED
condition Expression for evaluating condition

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.		 string Maximum length: 1024
display_value Overridden value to display, if any

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.		 string Maximum length: 255
icons Icons

Icons to be applied at dashboard for widgets and UI elements.		 array of Icon Minimum items: 0
tooltip Multi-line tooltip

Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.		 array of Tooltip Minimum items: 0

ReorderRequest (schema)

Name Description Type Notes
id id of the upgrade unit group/upgrade unit before/after which the upgrade unit group/upgrade unit is to be placed string Required
is_before flag indicating whether the upgrade unit group/upgrade unit is to be placed before or after the specified upgrade unit group/upgrade unit boolean Default: "True"

RequestParametersWithResoureType (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_type string
sort_ascending boolean
sort_by Field by which records are sorted string

RequiredTransportNodeIdParameters (schema)

Name Description Type Notes
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string Required

Resource (schema)

Base class for resources

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly

ResourceAllocation (schema)

Resource allocation information for a host infrastructure traffic type

Specify limit, shares and reservation for all kinds of traffic.
Values for limit and reservation are expressed in percentage. And for shares,
the value is expressed as a number between 1-100.
The overall reservation among all traffic types should not exceed 75%.
Otherwise, the API request will be rejected.

Name Description Type Notes
limit Maximum bandwidth percentage

The limit property specifies the maximum bandwidth allocation for a given
traffic type and is expressed in percentage. The default value for this
field is set to -1 which means the traffic is unbounded for the traffic
type. All other negative values for this property is not supported
and will be rejected by the API.
number Required
Minimum: -1
Maximum: 100
Default: "-1.0"
reservation Minimum guaranteed bandwidth percentage number Required
Minimum: 0
Maximum: 75
Default: "0.0"
shares Shares int Required
Minimum: 1
Maximum: 100
Default: "50"
traffic_type Resource allocation traffic type HostInfraTrafficType Required

ResourceLink (schema)

A link to a related resource

Name Description Type Notes
action Optional action string Readonly
href Link to resource string Required
Readonly
rel Link relation type

Custom relation type (follows RFC 5988 where appropriate definitions exist)		 string Required
Readonly

ResourceReference (schema)

A weak reference to an NSX resource.

Name Description Type Notes
is_valid Target validity

Will be set to false if the referenced NSX resource has been deleted.		 boolean Readonly
target_display_name Target display name

Display name of the NSX resource.		 string Readonly
Maximum length: 255
target_id Target ID

Identifier of the NSX resource.		 string Maximum length: 64
target_type Target type

Type of the NSX resource.		 string Maximum length: 255

RestoreConfiguration (schema)

Configuration where backup files are stored for restore

Name Description Type Notes
passphrase Passphrase used to encrypt backup files. string
remote_file_server The server from which backup files will be retrieved for restore. RemoteFileServer Required

RestoreStep (schema)

Restore step info

Name Description Type Notes
description Restore step description string Required
Readonly
status PerStepRestoreStatus
step_number Restore step number integer Required
Readonly
value Restore step value string Required
Readonly

RevisionedResource (schema)

A base class for types that track revisions

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly

Role (schema)

Role

Name Description Type Notes
role Role name string Required

RoleBinding (schema)

User/Group's role binding

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
name User/Group's name string Required
Readonly
resource_type Must be set to the value RoleBinding string
roles Roles array of Role Required
Readonly
stale Stale in vIDM

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		 string Readonly
Enum: TRUE, FALSE, UNKNOWN
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
type Type string Required
Readonly
Enum: remote_user, remote_group, local_user, principal_identity

RoleBindingListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List results array of RoleBinding Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

RoleBindingRequestParameters (schema)

Parameters to filter list of role bindings.

Pagination and Filtering parameters to get only a subset of users/groups.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
name User/Group name string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
type Type string Enum: remote_user, remote_group, local_user, principal_identity

RoleListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List results array of Role Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

RoleWithFeatures (schema)

Role

Name Description Type Notes
features Features array of FeaturePermission Required
role Role name string Required
Readonly

RouteBasedIPSecVPNSession (schema)

Route based VPN session

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Enable/Disable IPSec VPN session

Enable/Disable IPSec VPN session.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
ipsec_vpn_service_id IPSec VPN service identifier

Identifier of VPN Service linked with local endpoint.		 string Readonly
local_endpoint_id Local endpoint identifier

Local endpoint identifier.		 string Required
peer_endpoint_id Peer endpoint identifier

Peer endpoint identifier.		 string Required
resource_type Must be set to the value RouteBasedIPSecVPNSession IPSecVPNSessionResourceType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tunnel_ports IP Tunnel ports

IP Tunnel ports.		 array of TunnelPortConfig Required
Minimum items: 1
Maximum items: 1

RouteMap (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value RouteMap string
sequences Ordered list of routeMap sequences array of RouteMapSequence Required
Minimum items: 1
Maximum items: 1000
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

RouteMapListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paginated list of RouteMaps array of RouteMap Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

RouteMapSequence (schema)

Name Description Type Notes
action Action for the Sequence RoutingFilterAction Required
match_criteria Match Criteria for the RouteMap Sequence RouteMapSequenceMatch Required
set_criteria Set Criteria for the RouteMap Sequence RouteMapSequenceSet

RouteMapSequenceMatch (schema)

Match sequence in route map which is used for matching routes.
IP prefix lists and match community expression are mutually
exclusive fields, one of them must be provided.

Name Description Type Notes
ip_prefix_lists IPPrefixList Identifiers for RouteMap Sequence Match Criteria array of string Minimum items: 1
Maximum items: 500
match_community_expression Expression to match BGP communities

It supports conjunction operator (AND) and five
operators within singular community match expression
(MATCH_ANY, MATCH_ALL, MATCH_EXACT, MATCH_NONE,
MATCH_REGEX).
CommunityMatchExpression

RouteMapSequenceSet (schema)

Name Description Type Notes
as_path_prepend As Path Prepending to influence path selection string
community Either well-known community name or community value in aa:nn(2byte:2byte) format string
multi_exit_discriminator Multi Exit Discriminator (MED) integer Minimum: 0
Maximum: 4294967295
weight Weight used to select certain path int Minimum: 0
Maximum: 65535

RoutingConfig (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
forwarding_up_timer Forwarding up timer

Defines the extra time the router must wait before sending the UP notification
after the first BGP session is established. Default means forward immediately.
integer Default: "0"
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
resource_type Must be set to the value RoutingConfig string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

RoutingFilterAction (schema)

Action for Filters in Routing

Name Description Type Notes
RoutingFilterAction Action for Filters in Routing string Enum: PERMIT, DENY

RowListField (schema)

List of fields from which rows are formed

Root of the api result set for forming rows.

Name Description Type Notes
alias Alias Name

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).		 string Maximum length: 255
path JSON path

JSON path to the root of the api result set for forming rows.		 string Required
Maximum length: 1024

RuleState (schema)

Name Description Type Notes
details Array of configuration state of various sub systems array of ConfigurationStateElement Readonly
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
revision_desired revision number of the desired state integer Readonly
state Overall state of desired configuration

Gives details of state of desired configuration		 string Required
Readonly
Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown

SVMDeploymentSpec (schema)

Service-VM Deployment Spec

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.

Name Description Type Notes
host_type HostType

Host Type on which the specified OVF can be deployed.		 string Required
Enum: ESXI, RHELKVM, UBUNTUKVM
name name

Deployment Spec name for ease of use, since multiple DeploymentSpec can be specified.		 string
ovf_url OVF url

Location of the partner VM OVF to be deployed.		 string Required
service_form_factor Service Form Factor

Supported ServiceInsertion Form Factor for the OVF deployment. The default FormFactor is Medium.		 string Enum: SMALL, MEDIUM, LARGE
Default: "MEDIUM"

SavedSearch (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_saved Flag

The flag indicates whether the saved query is saved search or recent search.		 boolean Required
query Search string

The search query that is to be saved.		 string Required
resource_type Must be set to the value SavedSearch string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

SavedSearchListRequest (schema)

Request to get the list of all saved or recent searches

The request will contain the flag indicating whether the saved searches or the recent searches
is to be fetched.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
is_saved Flag

If true, only saved searches will be returned. If false, only recent searches will be
returned.
boolean Required
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

SavedSearchListResult (schema)

List of all Saved or recent searches

The results array will contain all the saved or recent search objects.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Saved search list results

The list of all saved searches by the user.		 array of SavedSearch Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

SavedSearchRequest (schema)

Save a search request

The request will contain the query to be saved and the flag indicating whether it is recent or
saved search.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_saved Flag

The flag indicates whether the query is recent or saved search.		 boolean Required
query search query

The search query that has to be saved.		 string Required
resource_type Must be set to the value SavedSearchRequest string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ScpProtocol (schema)

Name Description Type Notes
authentication_scheme Scheme to authenticate if required PasswordAuthenticationScheme Required
name Must be set to the value ScpProtocol string Required
Enum: http, https, scp, sftp
ssh_fingerprint SSH fingerprint of server string Required

SearchRequest (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
dsl Search DSL (domain specific language) query

It's human readable and context-based query language for retrieving
information from search indices.
For example: Find router where ip is 10.10.1.10
string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
query Search query string Required
sort_ascending boolean
sort_by Field by which records are sorted string

SearchResponse (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Search results array of object Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

SelectableResourceReference (schema)

Resources to take action on

Name Description Type Notes
is_valid Target validity

Will be set to false if the referenced NSX resource has been deleted.		 boolean Readonly
selected Set to true if this resource has been selected to be acted upon boolean Required
target_display_name Target display name

Display name of the NSX resource.		 string Readonly
Maximum length: 255
target_id Target ID

Identifier of the NSX resource.		 string Maximum length: 64
target_type Target type

Type of the NSX resource.		 string Maximum length: 255

SelfResourceLink (schema)

Link to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.

Name Description Type Notes
action Optional action string Readonly
href Link to resource string Required
Readonly
rel Link relation type

Custom relation type (follows RFC 5988 where appropriate definitions exist)		 string Required
Readonly

SelfSignedActionParameter (schema)

Name Description Type Notes
days_valid Number of days the certificate will be valid, default 10 years integer Required
Minimum: 1
Maximum: 10000
Default: "3650"

ServerAuthType (schema)

server authentication mode

Server authentication could be REQUIRED or IGNORE, it is used to specify
if the server certificate presented to the load balancer during handshake
should be actually validated or not. Validation is disabled by default.
If validation is REQUIRED, then to be accepted, server certificate must be
signed by one of the trusted CAs whose self signed certificates are
specified in the same server-side SSL profile binding.

Name Description Type Notes
ServerAuthType server authentication mode

Server authentication could be REQUIRED or IGNORE, it is used to specify
if the server certificate presented to the load balancer during handshake
should be actually validated or not. Validation is disabled by default.
If validation is REQUIRED, then to be accepted, server certificate must be
signed by one of the trusted CAs whose self signed certificates are
specified in the same server-side SSL profile binding.
string Enum: REQUIRED, IGNORE

ServerSslProfileBinding (schema)

Name Description Type Notes
certificate_chain_depth the maximum traversal depth of server certificate chain

authentication depth is used to set the verification depth in the server
certificates chain.
integer Minimum: 1
Maximum: 2147483647
Default: "3"
client_certificate_id client certificate identifier

To support client authentication (load balancer acting as a client
authenticating to the backend server), client certificate can be
specified in the server-side SSL profile binding
string
server_auth server authentication mode ServerAuthType Default: "IGNORE"
server_auth_ca_ids CA identifier list to verify server certificate

If server auth type is REQUIRED, server certificate must be signed by
one of the trusted Certificate Authorities (CAs), also referred to as
root CAs, whose self signed certificates are specified.
array of string
server_auth_crl_ids CRL identifier list to verify server certificate

A Certificate Revocation List (CRL) can be specified in the server-side
SSL profile binding to disallow compromised server certificates.
array of string
ssl_profile_id server SSL profile identifier

Server SSL profile defines reusable, application-independent server side
SSL properties.
string

ServiceAssociationListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
service_type string Required
Enum: FireWallServiceAssociationListResult, IpfixServiceAssociationListResult
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceAttachment (schema)

Logical Attachment Point for a 3rd Party Service

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
attachment_status Attachment Status

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.		 string Enum: UP, DOWN
Default: "UP"
deployed_to Deployed-to object

NSX Resource where we want to create Service Attachment Point. Ex. T0 LR Edge in case of HCX-ServiceInsertion.		 ResourceReference Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
local_ips Local IPs

Local IPs associated with this Service Attachment.		 array of IPInfo Required
Minimum items: 1
Maximum items: 1
logical_switch Logical Switch

Logical Switch gets created as a part of Service Attachment creation. If a Logical Switch is provided, then that needs to be used - instead of creating new one.		 ResourceReference Readonly
resource_type Must be set to the value ServiceAttachment string
service_port Service Port (Logical Router Centralized Service Port)

Service Port gets created as a part of Service Attachment creation. It is a Logical Router Port of type CentralizedServicePort. It does not participate in distributed routing. Stateless Policy Based Routing service can be applied on this port.		 ResourceReference Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ServiceAttachmentListResult (schema)

Service Attachment List

List of Service Attachments.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Service-Attachment list

List of the Service Attachments.		 array of ServiceAttachment Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceBinding (schema)

Name Description Type Notes
service_id UUID of Service

Identifier of Logical Service		 ResourceReference Required

ServiceDefinition (schema)

Definition of a Service.

Registering a Service is the first step in the ServiceInsertion mechanism. A ServiceDefinition is used to create a service.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
attachment_point Attachment Point

The point at which the service is deployed/attached for redirecting the traffic to the the partner appliance.		 array of string Required
Minimum items: 1
Maximum items: 1
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
functionalities Functionality Type

The capabilities provided by the services like NG_FW, IDS_IPS Hybrid Cloud Exchange(HCX) is specified here.		 array of string Required
Minimum items: 1
id Unique identifier of this resource string Readonly
Sortable
implementations Implementation Type

This indicates the insertion point of the service.		 array of string Required
Minimum items: 1
Maximum items: 1
on_failure_policy On Failure Policy

Failure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios.		 string Enum: ALLOW, BLOCK
Default: "ALLOW"
resource_type Must be set to the value ServiceDefinition string
service_deployment_spec Service Deployment Specification

Service Deployment Specification defines takes in information required to deploy and configure a partner appliance/service-vm.		 ServiceDeploymentSpec
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transports Transport Type

Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance.		 array of string Required
Minimum items: 1
vendor_id Vendor ID

Id which is unique to a vendor or partner for which the service is created.		 string Required

ServiceDeploymentSpec (schema)

Service Deployment Specification.

ServiceDeployment Spec consists of information required to deploy and configure the partner appliances. viz. Deployment template, deployment spec and NIC metatdata.

Name Description Type Notes
deployment_specs Service Deployment Spec List

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.		 array of SVMDeploymentSpec Maximum items: 128
deployment_template Service Deployment Template

Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX Manager.		 array of DeploymentTemplate Required
nic_metadata_list NIC Metadata

NIC metadata associated with the deployment spec.		 array of NicMetadata

ServiceEndpoint (schema)

Name Description Type Notes
certificate string
certificate_sha256_thumbprint string Readonly
fqdn string Readonly
ip_address IPAddress Required
port integer Required
Minimum: 0
Maximum: 65535

ServiceIP (schema)

Name Description Type Notes
ip_address Service IP address

Service IP address registerd by the service.		 IPv4Address Required
Readonly
is_advertised Flag to denote advertisement status of service IP

Flag to denote advertisement status of service IP to TIER0 LR.		 boolean Readonly
Default: "False"
is_arp_proxy_enabled Flag to denote status of ARP Proxy for service IP

Flag to denote status of ARP Proxy for service IP.		 boolean Readonly
Default: "False"
is_loopback_enabled Flag to denote loopback status for service IP

Flag to denote loopback status for service IP.		 boolean Readonly
Default: "False"
service Service which registered the ip

Service which registered the ip.		 ResourceReference Required
Readonly

ServiceIPsListParameters (schema)

Service IP list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

ServiceIPsListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paginated list of service IPs

List of service IPs registered with the LR by services like NAT, LB, VPN, etc.		 array of ServiceIP Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceInsertionListRequestParameters (schema)

Parameters to filter list of sections/rules

Pagination and Filtering parameters to get only a subset of sections/rules.

Name Description Type Notes
applied_tos AppliedTo's referenced by this section or section's Distributed Service Rules .

Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
destinations Destinations referenced by this section's Distributed Service Rules .

The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
filter_type Filter type

Filter type defines matching criteria to qualify a rule in result. Type
'FILTER' will ensure all criterias (sources, destinations, services,
appliedtos) are matched. Type 'SEARCH' will match any of the given
criteria.
string Enum: FILTER, SEARCH
Default: "FILTER"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
services NSService referenced by this section's Distributed Service Rules .

Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
sort_ascending boolean
sort_by Field by which records are sorted string
sources Sources referenced by this section's Distributed Service Rules .

The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string

ServiceInsertionRule (schema)

ServiceInsertion Rule

ServiceInsertion Rule.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_owner Owner of this resource OwnerResourceLink Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
action Action

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).		 string Required
Enum: ALLOW, DROP, REJECT, REDIRECT, DO_NOT_REDIRECT
applied_tos AppliedTo List

List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
destinations Destination List

List of the destinations. Null will be treated as any.		 array of ResourceReference Maximum items: 128
destinations_excluded Negation of destination

Negation of the destination.		 boolean Default: "False"
direction Rule direction

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.		 string Enum: IN, OUT, IN_OUT
Default: "IN_OUT"
disabled Rule enable/disable flag

Flag to disable rule. Disabled will only be persisted but never provisioned/realized.		 boolean Default: "False"
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Identifier of the resource string Readonly
ip_protocol IPv4 vs IPv6 packet type

Type of IP packet that should be matched while enforcing the rule.		 string Enum: IPV4, IPV6, IPV4_IPV6
Default: "IPV4_IPV6"
is_default Default rule

Flag to indicate whether rule is default.		 boolean Readonly
logged Enable logging flag

Flag to enable packet logging. Default is disabled.		 boolean Default: "False"
notes Notes

User notes specific to the rule.		 string Maximum length: 2048
redirect_tos Redirect_Tos List

A rule can be realized on a particular service definition, service instance or instance endpoint. If a service definition is selected as a redirect_to target, by default it will take the first deployed service instance if finds.		 array of ResourceReference Required
Maximum items: 1
resource_type Must be set to the value ServiceInsertionRule string
rule_tag Tag

User level field which will be printed in CLI and packet logs.		 string Maximum length: 32
services Service List

List of the services. Null will be treated as any.		 array of ServiceInsertionService Maximum items: 128
sources Source List

List of sources. Null will be treated as any.		 array of ResourceReference Maximum items: 128
sources_excluded Negation of source

Negation of the source.		 boolean Default: "False"

ServiceInsertionRuleListResult (schema)

ServiceInsertion Section RuleList

List of ServiceInsertion Rules.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results ServiceInsertion rule list result

ServiceInsertion rule list result with pagination support.		 array of ServiceInsertionRule Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceInsertionSection (schema)

ServiceInsertion Section

A ServiceInsertion section composed of ServiceInsertion Rules.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
applied_tos AppliedTo List

List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_default Default section flag

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.		 boolean Readonly
resource_type Must be set to the value ServiceInsertionSection string
rule_count Rule count

Number of rules in this section.		 integer Readonly
section_type Section Type

Type of the rules which a section can contain. Only homogeneous sections are supported.		 string Required
Enum: LAYER2, LAYER3, L3REDIRECT
stateful Stateful nature of the distributed service rules in the section.

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.		 boolean Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ServiceInsertionSectionFilterParameters (schema)

Parameters to filter section from list of sections

Pagination and Filtering parameters to get only a subset of sections.

Name Description Type Notes
applied_tos AppliedTo's referenced by this section or section's Distributed Service Rules .

Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
destinations Destinations referenced by this section's Distributed Service Rules .

The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
exclude_applied_to_type Limit result to sections not having a specific AppliedTo type

Used to filter out sections not having a specified AppliedTo target type. This parameter cannot be used along with include_applied_to_type parameter. Section filter only takes a single value for this param.		 DSAppliedToType
filter_type Filter type

Filter type defines matching criteria to qualify a rule in result. Type
'FILTER' will ensure all criterias (sources, destinations, services,
appliedtos) are matched. Type 'SEARCH' will match any of the given
criteria.
string Enum: FILTER, SEARCH
Default: "FILTER"
include_applied_to_type Limit result to sections having a specific AppliedTo type

Used to filter out results based on target type of a section's AppliedTo. Only sections with matching target type in its applied to will be returned. This parameter cannot be used along with exclude_applied_to_type parameter. Section filter only takes a single value for this param.		 DSAppliedToType
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
services NSService referenced by this section's Distributed Service Rules .

Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
sort_ascending boolean
sort_by Field by which records are sorted string
sources Sources referenced by this section's Distributed Service Rules .

The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.		 string
type Section Type

Section Type with values L3REDIRECT.		 string Enum: L3REDIRECT
Default: "L3REDIRECT"

ServiceInsertionSectionListResult (schema)

ServiceInsertion Section List

List of ServiceInsertion Sections.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Section list

List of the ServiceInsertion sections. The list has to be homogeneous.		 array of ServiceInsertionSection Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceInsertionSectionRuleList (schema)

ServiceInsertion Section RuleList

List of ServiceInsertion Rules.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
applied_tos AppliedTo List

List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.		 array of ResourceReference Maximum items: 128
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
is_default Default section flag

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.		 boolean Readonly
resource_type Must be set to the value ServiceInsertionSectionRuleList string
rule_count Rule count

Number of rules in this section.		 integer Readonly
rules List of the Service Insertion rules

List of Service Insertion rules in the section. Only homogeneous rules are supported.		 array of ServiceInsertionRule Required
Maximum items: 1000
section_type Section Type

Type of the rules which a section can contain. Only homogeneous sections are supported.		 string Required
Enum: LAYER2, LAYER3, L3REDIRECT
stateful Stateful nature of the distributed service rules in the section.

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.		 boolean Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ServiceInsertionService (schema)

ServiceInsertion Service

Protocol on which a particular ServiceInsertion Rule should apply to.

Name Description Type Notes
is_valid Target validity

Will be set to false if the referenced NSX resource has been deleted.		 boolean Readonly
service Distributed Service Network and Security Service element

Distributed Service API accepts raw protocol and ports as part of NS service element
in Distributed Service Rule that describes traffic corresponding to an NSService.
NSServiceElement
(Abstract type: pass one of the following concrete types)
ALGTypeNSService
EtherTypeNSService
ICMPTypeNSService
IGMPTypeNSService
IPProtocolNSService
L4PortSetNSService
target_display_name Target display name

Display name of the NSX resource.		 string Readonly
Maximum length: 255
target_id Target ID

Identifier of the NSX resource.		 string Maximum length: 64
target_type Target type

Type of the NSX resource.		 string Maximum length: 255

ServiceInsertionServiceListResult (schema)

Service List

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Service list

List of the Service-Insertion Services. The list has to be homogenous.		 array of ServiceDefinition Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceInstance (schema)

Normal Instance of a service

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
attachment_point Attachment Point

Attachment point to be used by this service instance for deploying the Service-VM.		 string Required
Enum: TIER0_LR, TIER1_LR
deployed_to Deployed-to object list

List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion.		 array of ResourceReference Required
Minimum items: 1
Maximum items: 128
deployment_mode Deployment Mode

Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.		 string Required
Enum: STAND_ALONE, ACTIVE_STANDBY
Default: "ACTIVE_STANDBY"
deployment_spec_name Deployment Spec Name

Name of the deployment spec to be used by this service instance.		 string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
implementation_type Implementation Type

Implementation to be used by this service instance for deploying the Service-VM.		 string Required
Enum: NORTH_SOUTH, EAST_WEST
instance_deployment_config Instance Deployment Config

Instance Deployment Config contains the information to be injected during Service-VM deployment.		 InstanceDeploymentConfig Required
instance_deployment_template Instance Deployment Template

The deployment template to be used by this service instance. The attribute values specific to this instance can be added.		 DeploymentTemplate Required
on_failure_policy On Failure Policy

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.		 string Enum: ALLOW, BLOCK
resource_type Must be set to the value ServiceInstance ServiceInstanceResourceType Required
service_id Service Id

The Service to which the service instance is associated.		 string Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_type Transport Type

Transport to be used by this service instance for deploying the Service-VM.		 string Required
Enum: L2_BRIDGE, L3_ROUTED

ServiceInstanceListResult (schema)

Service Instance List

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Service-Instance list

List of the Service-Insertion ServicesInstances. The list has to be homogenous.		 array of BaseServiceInstance
(Abstract type: pass one of the following concrete types)
ByodServiceInstance
ServiceInstance
VirtualServiceInstance		 Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceInstanceResourceType (schema)

Resource types of Service Instance

ServiceInstance is used when NSX handles the lifecyle of
appliance. Deployment and appliance related all the information is necessary.
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.
VirtualServiceInstance is a a custom instance to be used when NSX is not
handling the lifecycle of an appliance and when the user is not bringing
their own appliance.

Name Description Type Notes
ServiceInstanceResourceType Resource types of Service Instance

ServiceInstance is used when NSX handles the lifecyle of
appliance. Deployment and appliance related all the information is necessary.
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.
VirtualServiceInstance is a a custom instance to be used when NSX is not
handling the lifecycle of an appliance and when the user is not bringing
their own appliance.
string Enum: ServiceInstance, ByodServiceInstance, VirtualServiceInstance

ServiceProfile (schema) (Deprecated)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value ServiceProfile ServiceProfileResourceTypes Required
server_addresses array of IPAddress Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

ServiceProfileListResult (schema) (Deprecated)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results service profile list results array of ServiceProfile Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceProfileResourceTypes (schema) (Deprecated)

Resource types of service profiles

Name Description Type Notes
ServiceProfileResourceTypes Resource types of service profiles string Deprecated
Enum: DhcpRelayProfile

ServiceType (schema)

Supported service types, that are using certificates.

Name Description Type Notes
ServiceType Supported service types, that are using certificates. string Enum: MGMT_CLUSTER, MGMT_PLANE, API

SessionSummaryParameters (schema)

IPSec VPN session summary parameters

IPSec VPN session summary parameters.

Name Description Type Notes
site_id Peer site id

Peer site id.		 string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType

SftpProtocol (schema)

Name Description Type Notes
authentication_scheme Scheme to authenticate if required PasswordAuthenticationScheme Required
name Must be set to the value SftpProtocol string Required
Enum: http, https, scp, sftp
ssh_fingerprint SSH fingerprint of server string Required

SnatTranslationType (schema)

Snat translation type

Load balancers may need to perform SNAT to ensure reverse traffic from
the server can be received and processed by them.
There are two modes:
LbSnatAutoMap uses the load balancer interface IP and an
ephemeral port as the source IP and port of the server side connection.
LbSnatIpPool allows user to specify one or more IP addresses
along with their subnet masks that should be used for SNAT while
connecting to any of the servers in the pool.

Name Description Type Notes
SnatTranslationType Snat translation type

Load balancers may need to perform SNAT to ensure reverse traffic from
the server can be received and processed by them.
There are two modes:
LbSnatAutoMap uses the load balancer interface IP and an
ephemeral port as the source IP and port of the server side connection.
LbSnatIpPool allows user to specify one or more IP addresses
along with their subnet masks that should be used for SNAT while
connecting to any of the servers in the pool.
string Enum: LbSnatAutoMap, LbSnatIpPool

SnmpCommunity (schema)

Name Description Type Notes
access Type of access string Enum: read_only
Default: "read_only"
community_string Community string at most 64 characters long string Required
Pattern: "^[\S]{1,64}$"

SnmpServiceProperties (schema)

SNMP Service properties

Name Description Type Notes
communities SNMP v1, v2c community array of SnmpCommunity Maximum items: 1
start_on_boot Start when system boots boolean Required

SourceIpPersistencePurge (schema)

source ip persistence purge setting

If the persistence table is full and a new connection without a matching persistence entry is received, then by default(FULL) oldest persistence entries are purged from the table to make space for new entries. Each time purging gets triggered, a small percentage of the entries are purged. If purging is disabled(NO_PURGE) and a new incoming connection requires a persistence entry to be created, then that connection is rejected even though backend servers are available.

Name Description Type Notes
SourceIpPersistencePurge source ip persistence purge setting

If the persistence table is full and a new connection without a matching persistence entry is received, then by default(FULL) oldest persistence entries are purged from the table to make space for new entries. Each time purging gets triggered, a small percentage of the entries are purged. If purging is disabled(NO_PURGE) and a new incoming connection requires a persistence entry to be created, then that connection is rejected even though backend servers are available.		 string Enum: NO_PURGE, FULL

SpoofGuardSwitchingProfile (schema)

SpoofGuard configuration

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
required_capabilities array of string Readonly
resource_type Must be set to the value SpoofGuardSwitchingProfile string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
white_list_providers List of providers for white listed address bindings. array of WhiteListProvisionType Required

SshKeyBaseProperties (schema)

Name Description Type Notes
label SSH key label (used to identify the key) string Required
password Current password for user (required for users root and admin) string

SshKeyProperties (schema)

Name Description Type Notes
label SSH key label (used to identify the key) string Required
password Current password for user (required for users root and admin) string
type SSH key type string Required
Pattern: "^(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-dss|ssh-ed25519|ssh-rsa)$"
value SSH key value string Required

SshKeyPropertiesListResult (schema)

SSH key properties query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results SSH key properties query results array of SshKeyProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

SshServiceProperties (schema)

SSH Service properties

Name Description Type Notes
start_on_boot Start service when system boots boolean Required

SslCipher (schema)

SSL cipher

Name Description Type Notes
SslCipher SSL cipher string 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

SslCipherGroup (schema)

SSL cipher group

Name Description Type Notes
SslCipherGroup SSL cipher group string Enum: BALANCED, HIGH_SECURITY, HIGH_COMPATIBILITY, CUSTOM

SslProtocol (schema)

SSL protocol

Name Description Type Notes
SslProtocol SSL protocol string Enum: SSL_V2, SSL_V3, TLS_V1, TLS_V1_1, TLS_V1_2

StandardHostSwitch (schema)

Standard host switch specification

Name Description Type Notes
cpu_config Enhanced Networking Stack enabled HostSwitch CPU configuration

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.		 array of CpuCoreConfigForEnhancedNetworkingStackSwitch
host_switch_name host switch name. This name will be used to reference this 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.		 string Default: "nsxDefaultHostSwitch"
host_switch_profile_ids Identifiers of host switch profiles to be associated with this host switch.

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.		 array of HostSwitchProfileTypeIdEntry
ip_assignment_spec Specification for IPs to be used with host switch virtual tunnel endpoints

IPs can come from either a static IP pool or an explicitly specified IP list or DHCP. In case a list of IP is specified, the number of IPs provided should be sufficient as per teaming policy associated with host switch uplink profile.		 IpAssignmentSpec
(Abstract type: pass one of the following concrete types)
AssignedByDhcp
StaticIpListSpec
StaticIpMacListSpec
StaticIpPoolSpec
pnics Physical NICs connected to the host switch array of Pnic

StandardHostSwitchSpec (schema)

Specification of transport node standard host switch

Standard host switch specification is used for NSX configured transport node.

Name Description Type Notes
host_switches Transport Node host switches array of StandardHostSwitch Required
Minimum items: 0
Maximum items: 5
resource_type Must be set to the value StandardHostSwitchSpec string Required
Enum: StandardHostSwitchSpec, PreconfiguredHostSwitchSpec

StatItem (schema)

Statistic of an entity

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.

Name Description Type Notes
drilldown_id Id of drilldown widget

Id of drilldown widget, if any. Id should be a valid id of an existing widget.		 string
tooltip Multi-line tooltip

Multi-line text to be shown on tooltip while hovering over the stat.		 array of Tooltip Minimum items: 0
value Stat

Expression for stat to be displayed.		 string Required
Maximum length: 1024

StaticHopBfdPeer (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
bfd_config Configuration for the BFD peer

If not specified then BFD peer will inherit configuration from the BFD global config.		 BfdConfigParameters
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled status of BFD peer

Indicate BFD peer is enabled or disabled. Default is true.		 boolean Default: "True"
id Unique identifier of this resource string Readonly
Sortable
peer_ip_address IP address of BFD peer

IP address of BFD peer. This should be same as next hop IP address.		 IPv4Address Required
resource_type Must be set to the value StaticHopBfdPeer string
source_addresses Array of Logical Router Uplink IP Addresses

BFD peers will be created from all these source addresses to this neighbour.		 array of IPv4Address Maximum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

StaticHopBfdPeerListParameters (schema)

BFD Peers list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

StaticHopBfdPeerListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results static hop BFD peer list results array of StaticHopBfdPeer Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

StaticIpListSpec (schema)

IP assignment specification for Static IP List.

Name Description Type Notes
default_gateway Gateway IP IPAddress Required
ip_list List of IPs for transport node host switch virtual tunnel endpoints array of IPAddress Required
Maximum items: 32
resource_type Must be set to the value StaticIpListSpec string Required
Enum: StaticIpPoolSpec, StaticIpListSpec, AssignedByDhcp, StaticIpMacListSpec
subnet_mask Subnet mask IPAddress Required

StaticIpMacListSpec (schema)

IP and MAC assignment specification for Static IP List.

Name Description Type Notes
default_gateway Gateway IP IPAddress Required
ip_mac_list List of IPs and MACs for transport node host switch virtual tunnel endpoints array of IpMacPair Required
Maximum items: 32
resource_type Must be set to the value StaticIpMacListSpec string Required
Enum: StaticIpPoolSpec, StaticIpListSpec, AssignedByDhcp, StaticIpMacListSpec
subnet_mask Subnet mask IPAddress Required

StaticIpPoolSpec (schema)

IP assignment specification for Static IP Pool.

Name Description Type Notes
ip_pool_id string Required
resource_type Must be set to the value StaticIpPoolSpec string Required
Enum: StaticIpPoolSpec, StaticIpListSpec, AssignedByDhcp, StaticIpMacListSpec

StaticRoute (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
logical_router_id Logical router id string Readonly
network CIDR IPv4CIDRBlock Required
next_hops Next Hops array of StaticRouteNextHop Required
Minimum items: 1
resource_type Must be set to the value StaticRoute string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

StaticRouteListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paginated list of static routes array of StaticRoute Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

StaticRouteNextHop (schema)

Name Description Type Notes
administrative_distance Administrative Distance for the next hop IP integer Minimum: 1
Maximum: 255
Default: "1"
bfd_enabled 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. boolean Readonly
Default: "False"
blackhole_action Action to be taken on matching packets for NULL routes. BlackholeAction Readonly
ip_address Next Hop IP IPv4Address
logical_router_port_id Reference of logical router port to be used for next hop ResourceReference

StatsConfiguration (schema)

Stats Configuration

Represents configuration of a statistic for an entity. Example, number of logical switches and their admin states.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
datasources Array of Datasource Instances with their relative urls

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.		 array of Datasource Minimum items: 0
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
drilldown_id Id of drilldown widget

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.		 string Maximum length: 255
footer Footer
id Unique identifier of this resource string Readonly
Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.		 boolean Default: "False"
label Label of the Stats Configuration

Displayed at the sections, by default. It labels the entities of sections. If label is not provided, the sections are not labelled.		 Label
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details.		 string Maximum length: 1024
resource_type Must be set to the value StatsConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration
Maximum length: 255
sections Sections array of DonutSection Minimum items: 0
shared Visiblity of widgets to other users

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.		 boolean Deprecated
stat Expression for feching statistic of an entity

Expression that fetches statistic. 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. If stat is not provided, then it will not be displayed.		 StatItem
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.		 int Deprecated

StatusCount (schema)

Name Description Type Notes
degraded_count Degraded count int
down_count Down count int
status Roll-up status string Enum: UP, DOWN, DEGRADED, UNKNOWN
up_count Up count int

StatusSummaryRequestParameters (schema)

Name Description Type Notes
component_type Component type based on which upgrade units to be filtered string
selection_status Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units string Enum: SELECTED, DESELECTED, ALL
Default: "ALL"
show_history Get upgrade activity for a given component

Get details of the last 16 operations performed during the upgrade of a given component.		 boolean

StringMapEntry (schema)

Name Description Type Notes
key String key for the map string Required
value String value for the map entry string Maximum length: 8192

StructuredData (schema)

Structured data entry in RFC5424 log format

Name Description Type Notes
audit Audit flag of the log string Required
comp Component value of the log string Required
ent_id Entity Id value of the log string
ereq_id External request Id value of the log string
error_code Error Code value of the log string
level Level value of the log string
req_id Request Id value of the log string
s2comp Sub-subcomponent value of the log string
security Security flag of the log string
subcomp Subcomponent value of the log string Required
username Username value of the log string

SuccessNodeSupportBundleResult (schema)

Name Description Type Notes
bundle_name Name of support bundle, e.g. nsx_NODETYPE_UUID_YYYYMMDD_HHMMSS.tgz string Required
Readonly
bundle_size Size of support bundle in bytes integer Required
Readonly
node_display_name Display name of node string Required
Readonly
node_id UUID of node string Required
Readonly
sha256_thumbprint File's SHA256 thumbprint string Required
Readonly

SummaryRequest (schema)

Name Description Type Notes
summary Flag indicating whether to return the summary boolean Default: "False"

SupportBundleFileTransferAuthenticationScheme (schema)

Name Description Type Notes
password Password to authenticate with string Required
scheme_name Authentication scheme name string Required
Enum: PASSWORD
username User name to authenticate with string Required

SupportBundleFileTransferProtocol (schema)

Name Description Type Notes
authentication_scheme Scheme to authenticate if required SupportBundleFileTransferAuthenticationScheme Required
name Protocol name string Required
Enum: SCP, SFTP
ssh_fingerprint SSH fingerprint of server string Required

SupportBundleQueryParameter (schema)

Name Description Type Notes
override_async_response Override any existing support bundle async response

Override an existing support bundle async response if it exists. If not set to true and an existing async response is available, the support bundle request results in 409 CONFLICT.		 boolean Default: "False"

SupportBundleQueryParameters (schema)

Name Description Type Notes
all Include all files

Include all files including files that may have sensitive information like core files.		 boolean Default: "False"

SupportBundleRemoteFileServer (schema)

Remote file server

Name Description Type Notes
directory_path Remote server directory to copy bundle files to string Required
manager_upload_only Uploads to the remote file server performed by the manager boolean Default: "False"
port Server port integer Minimum: 1
Maximum: 65535
Default: "22"
protocol Protocol to use to copy file SupportBundleFileTransferProtocol Required
server Remote server hostname or IP address string Required

SupportBundleRequest (schema)

Name Description Type Notes
content_filters Bundle should include content of specified type array of ContentFilterValue Minimum items: 1
Default: "['DEFAULT']"
log_age_limit Include log files with modified times not past the age limit in days integer Minimum: 1
nodes List of cluster/fabric node UUIDs processed in specified order array of string Required
Minimum items: 1
remote_file_server Remote file server to copy bundles to, bundle in response body if not specified SupportBundleRemoteFileServer

SupportBundleResult (schema)

Name Description Type Notes
failed_nodes Nodes where bundles were not generated or not copied to remote server array of FailedNodeSupportBundleResult Required
Readonly
remaining_nodes Nodes where bundle generation is pending or in progress array of RemainingSupportBundleNode
request_properties Request properties SupportBundleRequest Required
Readonly
success_nodes Nodes whose bundles were successfully copied to remote file server array of SuccessNodeSupportBundleResult Required
Readonly

SwitchSecuritySwitchingProfile (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
block_non_ip_traffic A flag to block all traffic except IP/(G)ARP/BPDU boolean Default: "False"
bpdu_filter Enables or disables BPDU filtering

BPDU filtering is enabled by default. A pre-defined list of MAC addresses
are automatically excluded from BPDU filtering.
BpduFilter
description Description of this resource string Maximum length: 1024
Sortable
dhcp_filter Filters DHCP server and/or client traffic.

DHCP server blocking is enabled and client blocking is disabled by default		 DhcpFilter
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
rate_limits Allows configuration of rate limits for broadcast and multicast traffic

Rate limiting is disabled by default		 RateLimits
required_capabilities array of string Readonly
resource_type Must be set to the value SwitchSecuritySwitchingProfile string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

SwitchingProfileListParameters (schema)

Switching profile list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
include_system_owned Whether the list result contains system resources boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
switching_profile_type comma-separated list of switching profile types, e.g. ?switching_profile_type=QosSwitchingProfile,PortMirroringSwitchingProfile string

SwitchingProfileType (schema)

Supported switching profiles.

Name Description Type Notes
SwitchingProfileType Supported switching profiles. string Enum: QosSwitchingProfile, PortMirroringSwitchingProfile, IpDiscoverySwitchingProfile, SpoofGuardSwitchingProfile, SwitchSecuritySwitchingProfile, MacManagementSwitchingProfile

SwitchingProfileTypeIdEntry (schema)

Name Description Type Notes
key SwitchingProfileType
value key value string Required

SwitchingProfilesListResult (schema)

Switching Profile queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Switching Profile Results array of BaseSwitchingProfile
(Abstract type: pass one of the following concrete types)
IpDiscoverySwitchingProfile
MacManagementSwitchingProfile
PortMirroringSwitchingProfile
QosSwitchingProfile
SpoofGuardSwitchingProfile
SwitchSecuritySwitchingProfile		 Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

SwitchingToVmcModeParameters (schema)

Parameters required to switch to VMC nsx node mode

Possible values of a mode in a "/config/nsx_appliance_mode" file

Name Description Type Notes
auth_code Auth Code

Client's credentials.		 Oauth2Credentials Required
base_url CSP base URL

Protocol and domain name (or IP address) of a CSP server, like "https://console-stg.cloud.vmware.com".		 string Required
csp_client_credential CSP Client Credential

Client's credentials on CSP server		 Oauth2Credentials
csp_client_incoming_credentials CSP client incoming credentials

List of incoming client IDs		 array of string
csp_org_uri Relative path to CSP Org

Relative path on CSP server to the Org location. Can be "/csp/gateway/am/api/orgs/".		 string Required
csp_time_drift CSP time drift

CSP time drift in milliseconds		 integer
default_org_id Org ID of a Client

Org ID of a Client - commonly UUID.		 string Required
ea_org Org Info for "Site Reliability Engineer"

Org ID and role of "Site Reliability Engineer"		 OrgInfo
gss_org Org Info for "Global Support Services"

Org ID and role of "Global Support Services"		 OrgInfo
mode_change_only Only change node mode

When this parameter is set to true, only a change in the node mode happens without any update to auth properties. The required params would need to provided but they would be ignored in the backed. When this param is not set to true i.e. set to false or not provided, the mode change and auth properties update will both happen.		 boolean
mode_id Nsx node mode

Possible enum values in a "/config/nsx_appliance_mode" file		 string Required
Enum: ON_PREM, SERVICE, VMC, VMC_LOCAL
proxy_host IP/host of PoP (Point-of-Presence) Http proxy server HostnameOrIPv4Address
proxy_port Port of PoP (Point-of-Presence) Http proxy server integer Minimum: 1
Maximum: 65535
sddc_id SDDC id

SDDC id		 string
service_definition_id Service definition id

Service definition id		 string
sre_org Org Info for "Enterprise Admin"

Org ID and role of "Enterprise Admin"		 OrgInfo

SyslogFacility (schema)

Syslog facility

Name Description Type Notes
SyslogFacility Syslog facility string Enum: KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, AUTHPRIV, FTP, LOGALERT, CRON, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7

SystemHostname (schema)

System host name

Name Description Type Notes
SystemHostname System host name string Maximum length: 255
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])?)*\.?$"

Tag (schema)

Arbitrary key-value pairs that may be attached to an entity

Name Description Type Notes
scope Tag scope

Tag searches may optionally be restricted by scope		 string Maximum length: 128
Default: ""
tag Tag value

Identifier meaningful to user		 string Maximum length: 256
Default: ""

TargetResourceStatus (schema)

Holds status of target resource in firewall context.

Name Description Type Notes
target_id Target ID

Identifier of the NSX resource.		 string Maximum length: 64
target_status Firewall Status Type

Firewall status on a target logical resource.		 FirewallStatusType Required

TaskListResult (schema)

Task query results

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Task property results array of TaskProperties Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TaskProperties (schema)

Task properties

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
async_response_available True if response for asynchronous request is available boolean Readonly
cancelable True if this task can be canceled boolean Readonly
description Description of the task string Readonly
end_time The end time of the task in epoch milliseconds EpochMsTimestamp Readonly
id Identifier for this task string Readonly
message A message describing the disposition of the task string Readonly
progress Task progress if known, from 0 to 100 integer Readonly
Minimum: 0
Maximum: 100
request_method HTTP request method string Readonly
request_uri URI of the method invocation that spawned this task string Readonly
start_time The start time of the task in epoch milliseconds EpochMsTimestamp Readonly
status Current status of the task TaskStatus Readonly
user Name of the user who created this task string Readonly

TaskQueryParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
request_uri Request URI(s) to include in query result

Comma-separated request URIs to include in query result		 string
sort_ascending boolean
sort_by Field by which records are sorted string
status Status(es) to include in query result

Comma-separated status values to include in query result		 string
user Names of users to include in query result

Comma-separated user names to include in query result		 string

TaskStatus (schema)

Current status of the task

Name Description Type Notes
TaskStatus Current status of the task string Enum: running, error, success, canceling, canceled, killed

TeamingPolicy (schema)

Uplink Teaming Policy

Name Description Type Notes
active_list List of Uplinks used in active list array of Uplink Required
policy Teaming policy string Required
Enum: FAILOVER_ORDER, LOADBALANCE_SRCID
standby_list List of Uplinks used in standby list array of Uplink

TelemetryAgreement (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value TelemetryAgreement string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
telemetry_agreement_displayed Flag to indicate if telemetry agreement has been displayed

Determine if telemetry agreement has been displayed. If false,
the agreement text will be displayed at login time.
boolean Required

TelemetryConfig (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
ceip_acceptance Flag to indicate if CEIP has been accepted

Enable this flag to participate in the Customer Experience Improvement Program.
boolean Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
proxy_enabled Flag to indicate if proxy has been configured

Enable this flag to specify a proxy, and provide the proxy settings.		 boolean Default: "False"
resource_type Must be set to the value TelemetryConfig string
schedule_enabled Flag to indicate if data collection is enabled

Enable this to schedule data collection and upload times. If enabled,
and a schedule is not provided, a default schedule (WEEKLY, Sunday at 2:00 a.m)
will be applied.
boolean Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
telemetry_proxy Set config for proxy to be used to send out telemetry data

Specify the proxy configuration (scheme, server, port) here.		 TelemetryProxy
telemetry_schedule Set schedule for when telemetry data should be collected

Specify one of Daily, Weekly or Monthly schedules.		 TelemetrySchedule
(Abstract type: pass one of the following concrete types)
DailyTelemetrySchedule
MonthlyTelemetrySchedule
WeeklyTelemetrySchedule

TelemetryProxy (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
hostname FQDN or IP address of the proxy server

Specify the fully qualified domain name, or ip address, of the proxy server.
string Required
id Unique identifier of this resource string Readonly
Sortable
password Password

Specify the password used to authenticate with the proxy server, if required.
A GET call on /telemetry/config returns a non-meaningful password to maintain
security. To change the password to a new value, issue a PUT call after updating
this field. To remove the password, issue a PUT call after emptying this field.
To retain a previously set password, issue a PUT call keeping the non-meaningful
value obtained from the GET call.
string
port Configured port for proxy

Specify the port of the proxy server.		 int Required
resource_type Must be set to the value TelemetryProxy string
scheme The scheme accepted by the proxy server

The scheme accepted by the proxy server. Specify one of HTTP and HTTPS.
string Required
Enum: HTTP, HTTPS
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
username User name

Specify the user name used to authenticate with the proxy server, if required.
string

TelemetrySchedule (schema)

Abstract base type for telemetry schedule configuration

This is an abstract type. Concrete child types:
DailyTelemetrySchedule
MonthlyTelemetrySchedule
WeeklyTelemetrySchedule

Name Description Type Notes
frequency_type Frequency at which data will be collected

Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.		 string Required

Tooltip (schema)

Tooltip

Tooltip to be shown while hovering over the dashboard UI element.

Name Description Type Notes
condition Expression for evaluating condition

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.		 string Maximum length: 1024
text Textbox shown at tooltip

Text to be shown on tooltip while hovering over UI element. The text would be wrapped if it exceeds 80 chars.		 string Required
Maximum length: 1024

Traceflow (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
analysis Traceflow result analysis notes array of string Readonly
counters observation counters TraceflowObservationCounters Readonly
id The id of the traceflow round string Required
Readonly
logical_counters counters of observations from logical components TraceflowObservationCounters Readonly
lport_id id of the source logical port used for injecting the traceflow packet string Readonly
operation_state Represents the traceflow operation state string Required
Readonly
Enum: IN_PROGRESS, FINISHED, FAILED
request_status Traceflow request status

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 is not found. DATA_PATH_NOT_READY - The datapath component is not ready to receive request. CONNECTION_ERROR - There is connection error on datapath component.		 string Readonly
Enum: SUCCESS, TIMEOUT, SOURCE_PORT_NOT_FOUND, DATA_PATH_NOT_READY, CONNECTION_ERROR
result_overflowed A flag, when set true, indicates some observations were deleted from the result set. boolean Readonly
timeout Timeout (in ms) for traceflow observations result list

Maximum time (in ms) the management plane will be waiting for this traceflow round.		 integer Readonly
Minimum: 5000
Maximum: 15000

TraceflowComponentSubType (schema)

Name Description Type Notes
TraceflowComponentSubType string Enum: LR_TIER0, LR_TIER1, LR_VRF_TIER0, LS_TRANSIT, UNKNOWN

TraceflowComponentType (schema)

Name Description Type Notes
TraceflowComponentType string Enum: PHYSICAL, LR, LS, DFW, BRIDGE, EDGE_TUNNEL, EDGE_HOSTSWITCH, UNKNOWN

TraceflowListParameters (schema)

Traceflow list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
lport_id id of the source logical port where the trace flows originated string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

TraceflowListResult (schema)

Traceflow queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Traceflow Results array of Traceflow Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TraceflowObservation (schema)

Name Description Type Notes
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
resource_type TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly

TraceflowObservationCounters (schema)

Name Description Type Notes
delivered_count Delivered observation count

Total number of delivered observations for this traceflow round.		 integer Readonly
dropped_count Dropped observation count

Total number of dropped observations for this round.		 integer Readonly
forwarded_count Forwarded observation count

Total number of forwarded observations for this traceflow round.		 integer Readonly
received_count Received observation count

Total number of received observations for this traceflow round.		 integer Readonly

TraceflowObservationDelivered (schema)

Name Description Type Notes
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
lport_id The id of the logical port into which the traceflow packet was delivered string Readonly
lport_name The name of the logical port into which the traceflow packet was delivered string Readonly
resource_type Must be set to the value TraceflowObservationDelivered TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly
vlan_id VLAN on bridged network VlanID

TraceflowObservationDropped (schema)

Name Description Type Notes
acl_rule_id The id of the acl rule that was applied to drop the traceflow packet integer Readonly
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
lport_id The id of the logical port at which the traceflow packet was dropped string Readonly
lport_name The name of the logical port at which the traceflow packet was dropped string Readonly
reason The reason traceflow packet was dropped string Readonly
Enum: ARP_FAIL, BFD, DHCP, FW_RULE, GENEVE, GRE, IFACE, IP, IP_REASS, IPSEC, IPSEC_VTI, L2VPN, L4PORT, LB, LROUTER, LSERVICE, LSWITCH, MD_PROXY, NAT, NEIGH, NO_ROUTE, SERVICE_INSERT, TTL_ZERO, TUNNEL, VXLAN, VXSTT, UNKNOWN
resource_type Must be set to the value TraceflowObservationDropped TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly

TraceflowObservationDroppedLogical (schema)

Name Description Type Notes
acl_rule_id The id of the acl rule that was applied to drop the traceflow packet integer Readonly
component_id The id of the component that dropped the traceflow packet. string Readonly
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
lport_id The id of the logical port at which the traceflow packet was dropped string Readonly
lport_name The name of the logical port at which the traceflow packet was dropped string Readonly
reason The reason traceflow packet was dropped string Readonly
Enum: ARP_FAIL, BFD, DHCP, FW_RULE, GENEVE, GRE, IFACE, IP, IP_REASS, IPSEC, IPSEC_VTI, L2VPN, L4PORT, LB, LROUTER, LSERVICE, LSWITCH, MD_PROXY, NAT, NEIGH, NO_ROUTE, SERVICE_INSERT, TTL_ZERO, TUNNEL, VXLAN, VXSTT, UNKNOWN
resource_type Must be set to the value TraceflowObservationDroppedLogical TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly

TraceflowObservationForwarded (schema)

Name Description Type Notes
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
context The 64bit tunnel context carried on the wire. integer
dst_transport_node_id The id of the transport node to which the traceflow packet is forwarded

This field will not be always available. Use remote_ip_address when this field is not set.		 string Readonly
dst_transport_node_name The name of the transport node to which the traceflow packet is forwarded string Readonly
local_ip_address IP address of the source end of the tunnel IPAddress
remote_ip_address IP address of the destination end of the tunnel IPAddress
resource_type Must be set to the value TraceflowObservationForwarded TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly
uplink_name The name of the uplink the traceflow packet is forwarded on string
vtep_label The virtual tunnel endpoint label integer

TraceflowObservationForwardedLogical (schema)

Name Description Type Notes
acl_rule_id The id of the acl rule that was applied to forward the traceflow packet integer Readonly
component_id The id of the component that forwarded the traceflow packet. string Readonly
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
dst_component_id The id of the destination component to which the traceflow packet was forwarded. string Readonly
dst_component_name The name of the destination component to which the traceflow packet was forwarded. string Readonly
dst_component_type The type of the destination component to which the traceflow packet was forwarded. TraceflowComponentType Readonly
lport_id The id of the logical port through which the traceflow packet was forwarded. string Readonly
lport_name The name of the logical port through which the traceflow packet was forwarded. string Readonly
resource_type Must be set to the value TraceflowObservationForwardedLogical TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly
vni VNI for the logical network on which the traceflow packet was forwarded. int Readonly

TraceflowObservationListParameters (schema)

Traceflow Observation list parameters

Name Description Type Notes
component_name Observations having the given component name will be listed.

Observations of all component names will be listed if not given.		 string
component_type Observations having the given component type will be listed.

Observations of all component types will be listed if not given.		 TraceflowComponentType
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_type The type of observations that will be listed.

Prefix matching; e.g. TraceflowObservationReceived will also matches TraceflowObservationReceivedLogical. Observations of all types will be listed if not given.		 TraceflowObservationType
sort_ascending boolean
sort_by Field by which records are sorted string
transport_node_name Observations having the given transport node name will be listed.

Observations of all transport node names will be listed if not given.		 string

TraceflowObservationListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results TraceflowObservation list results array of TraceflowObservation
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TraceflowObservationReceived (schema)

Name Description Type Notes
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
local_ip_address IP address of the destination end of the tunnel IPAddress
remote_ip_address IP address of the source end of the tunnel IPAddress
resource_type Must be set to the value TraceflowObservationReceived TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly
uplink_name The name of the uplink the traceflow packet is received on string
vtep_label The virtual tunnel endpoint label integer

TraceflowObservationReceivedLogical (schema)

Name Description Type Notes
component_id The id of the component that received the traceflow packet. string Readonly
component_name The name of the component that issued the observation. string Readonly
component_sub_type The sub type of the component that issued the observation. TraceflowComponentSubType Readonly
component_type The type of the component that issued the observation. TraceflowComponentType Readonly
lport_id The id of the logical port at which the traceflow packet was received string Readonly
lport_name The name of the logical port at which the traceflow packet was received string Readonly
resource_type Must be set to the value TraceflowObservationReceivedLogical TraceflowObservationType Required
Default: "TraceflowObservationReceived"
sequence_no the sequence number is the traceflow observation hop count

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.		 integer Required
Readonly
src_component_id The id of the source component from which the traceflow packet was received. string Readonly
src_component_name The name of source component from which the traceflow packet was received. string Readonly
src_component_type The type of the source component from which the traceflow packet was received. TraceflowComponentType Readonly
timestamp Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (milliseconds epoch)		 EpochMsTimestamp Readonly
timestamp_micro Timestamp when the observation was created by the transport node

Timestamp when the observation was created by the transport node (microseconds epoch)		 integer Readonly
transport_node_id id of the transport node that observed a traceflow packet string Readonly
transport_node_name name of the transport node that observed a traceflow packet string Readonly
transport_node_type type of the transport node that observed a traceflow packet TransportNodeType Readonly
vni VNI for the logical network on which the traceflow packet was received. int Readonly

TraceflowObservationType (schema)

Name Description Type Notes
TraceflowObservationType string Enum: TraceflowObservationForwarded, TraceflowObservationDropped, TraceflowObservationDelivered, TraceflowObservationReceived, TraceflowObservationForwardedLogical, TraceflowObservationDroppedLogical, TraceflowObservationReceivedLogical

TransportNode (schema)

Transport Node

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
host_switch_spec Transport node host switch specification

This property is used to either create standard host switches
or to inform NSX about preconfigured host switches that already
exist on the transport node.

Pass an array of either StandardHostSwitchSpec objects or
PreconfiguredHostSwitchSpec objects. It is an error to pass
an array containing different types of HostSwitchSpec objects.
HostSwitchSpec
(Abstract type: pass one of the following concrete types)
PreconfiguredHostSwitchSpec
StandardHostSwitchSpec
host_switches Transport Node switch(s). Prefer host_switch_spec over this.

This property is deprecated in favor of 'host_switch_spec'. Property 'host_switches' can only be used for NSX managed transport nodes. 'host_switch_spec' can be used for both NSX managed or manually preconfigured host switches.		 array of HostSwitch Deprecated
id Unique identifier of this resource string Readonly
Sortable
maintenance_mode transport node maintenance mode desired state

The property is read-only, used for querying result. User could update transport node maintenance mode by UpdateTransportNodeMaintenanceMode call.		 string Readonly
Enum: ENABLED, FORCE_ENABLED, DISABLED
node_id Unique Id of the fabric node string Required
resource_type Must be set to the value TransportNode string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_zone_endpoints Transport zone endpoints. array of TransportZoneEndPoint

TransportNodeIdParameters (schema)

Name Description Type Notes
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
transport_node_id TransportNode Id string

TransportNodeListParameters (schema)

Transport Node list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
in_maintenance_mode maintenance mode flag

If the flag is true, transport node with 'ENABLED' or 'FORCE_ENABLED' desired state will be returned, otherwise transport nodes in 'DISABLED' will be returned.		 boolean
included_fields Comma separated list of fields that should be included in query result string
node_id node identifier

This property can be used by itself or along with 'transport_zone_id'.		 string
node_ip Fabric node IP address

This property can only be used alone. It can not be combined with other filtering properties.		 string
node_types a list of fabric node types separated by comma or a single type

The fabric node type is the resource_type of the Node such as HostNode, EdgeNode and PublicCloudGatewayNode. If a list of fabric node types are given, all transport nodes of all given types will be returned.		 string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
transport_zone_id Transport zone identifier

This propery can be used along with 'node_id'.		 string

TransportNodeListResult (schema)

Transport Node queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results TransportNode Results array of TransportNode Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TransportNodeReportParameters (schema)

Name Description Type Notes
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
status Transport node string Enum: UP, DOWN, DEGRADED

TransportNodeState (schema)

Transport Node State

Name Description Type Notes
details Array of configuration state of various sub systems array of ConfigurationStateElement Readonly
failure_code Error code integer Readonly
failure_message Error message in case of failure string Readonly
host_switch_states States of HostSwitches on the host array of HostSwitchState Readonly
maintenance_mode_state the present realized maintenance mode state MaintenanceModeState Readonly
state Overall state of desired configuration

Gives details of state of desired configuration		 string Required
Readonly
Enum: pending, in_progress, success, failed, partial_success, orphaned, unknown
transport_node_id Unique Id of the TransportNode string Readonly

TransportNodeStateListResult (schema)

Transport node state queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Transport Node State Results array of TransportNodeState Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TransportNodeStatus (schema)

Name Description Type Notes
control_connection_status Control connection status StatusCount
mgmt_connection_status Management connection status string Enum: UP, DOWN
node_display_name Display name

Transport node display name		 string
node_uuid Transport node uuid string
pnic_status pNIC status StatusCount
status Roll-up status of pNIC, management connection, control connection, tunnel status string Enum: UP, DOWN, DEGRADED, UNKNOWN
tunnel_status Tunnel Status TunnelStatusCount

TransportNodeStatusListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List of transport node statuses array of TransportNodeStatus
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TransportNodeStatusParametersWithDataSource (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
source The data source, either realtime or cached. If not provided, cached data is returned. DataSourceType
status Transport node

Rolled-up status of pNIC, management connection, control connection, and tunnel status. UP means all of these are up; DOWN represents the state when pNIC status is down. DEGRADED status here represents the state for a node when its pNIC bond status is DEGRADED, or, its Control connection status is either DEGRADED or DOWN. UNKNOWN is the case when both control connection and tunnel status are unknown. If none of these conditions are true, the node status is considered DOWN.		 string Enum: UP, DOWN, DEGRADED, UNKNOWN

TransportNodeTemplateListResult (schema)

Compute collection transport node template list result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Compute collection transport node template results array of ComputeCollectionTransportNodeTemplate Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TransportNodeTemplateState (schema)

transport node template application state

Name Description Type Notes
node_id node id string Required
state Application state of transport node template on this host

Transport node template state on individual hosts of ComputeCollection
which enabled automated transport code creation.
'FAILED_TO_CREATE' means transport node isn't created. 'IN_PROGRESS' means
transport node is in progress of creation. 'FAILED_TO_REALIZE' means
transport node has been created, but failed on host realization, it will
repush to host by NSX later. 'SUCCESS' means transport node creation is
succeeded.
string Readonly
Enum: FAILED_TO_CREATE, IN_PROGRESS, FAILED_TO_REALIZE, SUCCESS
transport_node_id transport node id string

TransportNodeTemplateStateParameters (schema)

Transport node template state parameters

Name Description Type Notes
compute_collection_id Compute collection id string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

TransportNodeType (schema)

Name Description Type Notes
TransportNodeType string Enum: ESX, RHELKVM, UBUNTUKVM, EDGE, PUBLIC_CLOUD_GATEWAY_NODE, OTHERS, HYPERV

TransportType (schema)

Name Description Type Notes
TransportType string Enum: OVERLAY, VLAN

TransportZone (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
host_switch_id the host switch id generated by the system. string Readonly
host_switch_mode Operational mode of Transport Zone.

STANDARD mode applies to all the hypervisors. ENS mode stands for Enhanced Networking Stack. This feature is only available for ESX hypervisor. It is not available on KVM, EDGE and Public Cloud Gateway etc. When a Transport Zone mode is set to ENS, only Transport Nodes of type ESX can participate in such a Transport Zone.		 string Enum: STANDARD, ENS
Default: "STANDARD"
host_switch_name Name of the host switch on all transport nodes in this transport zone that will be used to run NSX network traffic.

If this name is unset or empty then the default host switch name will be used.		 string Default: "nsxDefaultHostSwitch"
id Unique identifier of this resource string Readonly
Sortable
nested_nsx Flag to indicate if transport nodes in this transport zone are connected through nested NSX.

The flag only need to be set in nested NSX environment.		 boolean Default: "False"
resource_type Must be set to the value TransportZone string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_type The transport type of this transport zone. TransportType Required
transport_zone_profile_ids Identifiers of the transport zone profiles associated with this TransportZone. array of TransportZoneProfileTypeIdEntry
uplink_teaming_policy_names Names of the switching uplink teaming policies that are supported by this transport zone.

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.		 array of string

TransportZoneEndPoint (schema)

This object associates TransportNode to a certain TransportZone

Specify which HostSwitch from this TransportNode is used handle traffic for given TransportZone

Name Description Type Notes
transport_zone_id Unique ID identifying the transport zone for this endpoint string Required
transport_zone_profile_ids Identifiers of the transport zone profiles associated with this transport zone endpoint on this transport node. array of TransportZoneProfileTypeIdEntry

TransportZoneInfo (schema)

Name Description Type Notes
is_underlay_transport_zone Flag to identify if this is the underlay transport zone boolean Readonly
logical_switches Logical switches for the transport zone array of LogicalSwitchInfo Readonly
transport_zone_display_name Name of the transport zone string Readonly
transport_zone_id ID of the transport zone string Readonly

TransportZoneListParameters (schema)

Transport Zone list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
uplink_teaming_policy_name The transport zone's uplink teaming policy name

All transport zone's with the specified uplink teaming policy name. Otherwise, transport zones with any uplink teaming policy will be returned.		 string

TransportZoneListResult (schema)

Transport zone queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Transport Zone Results array of TransportZone Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TransportZoneProfile (schema)

This is an abstract type. Concrete child types:
BfdHealthMonitoringProfile

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value TransportZoneProfile string Required
Enum: BfdHealthMonitoringProfile
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

TransportZoneProfileListParameters (schema)

Transport zone profile list parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
include_system_owned Whether the list result contains system resources boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
resource_type comma-separated list of transport zone profile types, e.g. ?resource_type=BfdHealthMonitoringProfile string
sort_ascending boolean
sort_by Field by which records are sorted string

TransportZoneProfileListResult (schema)

Transport zone profile queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Transport zone profile results array of TransportZoneProfile
(Abstract type: pass one of the following concrete types)
BfdHealthMonitoringProfile		 Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TransportZoneProfileType (schema)

Supported transport zone profiles.

Name Description Type Notes
TransportZoneProfileType Supported transport zone profiles. string Enum: BfdHealthMonitoringProfile

TransportZoneProfileTypeIdEntry (schema)

Name Description Type Notes
profile_id profile id of the resource type string Required
resource_type Selects the type of the transport zone profile TransportZoneProfileType

TransportZoneStatus (schema)

Transport zone runtime status information

Name Description Type Notes
num_logical_ports Count of logical ports in the transport zone int Required
Readonly
num_logical_switches Count of logical switches in the transport zone int Required
Readonly
num_transport_nodes Count of transport nodes in the transport zone int Required
Readonly
transport_zone_id Unique ID identifying the transport zone string Required
Readonly

TransportZoneStatusListResult (schema)

Transport zone runtime status queries result

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Transport Zone Runtime Status Info Results array of TransportZoneStatus Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

TrunkVlanRange (schema)

Trunk VLAN id range

Name Description Type Notes
end VlanID Required
start VlanID Required

TrustManagementData (schema)

Name Description Type Notes
supported_algorithms list of supported algorithms array of CryptoAlgorithm Readonly

TrustObjectData (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
key_algo Key algorithm contained in this certificate string
passphrase Password for private key encryption string
pem_encoded pem encoded certificate data string Required
private_key private key data string
resource_type Must be set to the value TrustObjectData string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

TunnelDigestAlgorithm (schema)

Digest Algorithms used in tunnel establishment

The TunnelDigestAlgorithms are used to verify message
integrity during IPSec VPN tunnel establishment.
SHA1 produces 160 bits hash and SHA2_XXX produces
XXX bit hash.

Name Description Type Notes
TunnelDigestAlgorithm Digest Algorithms used in tunnel establishment

The TunnelDigestAlgorithms are used to verify message
integrity during IPSec VPN tunnel establishment.
SHA1 produces 160 bits hash and SHA2_XXX produces
XXX bit hash.
string Enum: SHA1, SHA2_256, SHA2_384, SHA2_512

TunnelEncryptionAlgorithm (schema)

Encryption algorithm used in tunnel

TunnelEncryption algorithms are used to ensure confidentiality
of the messages exchanged during Tunnel negotiations. AES
stands for Advanced Encryption Standards. AES_128 uses 128-bit
keys whereas AES_256 uses 256-bit keys for encryption and
decryption. AES_GCM stands for Advanced Encryption Standard(AES)
in Galois/Counter Mode (GCM) and is used to provide both
confidentiality and data origin authentication.
NO_ENCRYPTION_AUTH_AES_GMAC_* enables authentication on input
data without encyption. Digest algorithm should be empty for this
option.

Name Description Type Notes
TunnelEncryptionAlgorithm Encryption algorithm used in tunnel

TunnelEncryption algorithms are used to ensure confidentiality
of the messages exchanged during Tunnel negotiations. AES
stands for Advanced Encryption Standards. AES_128 uses 128-bit
keys whereas AES_256 uses 256-bit keys for encryption and
decryption. AES_GCM stands for Advanced Encryption Standard(AES)
in Galois/Counter Mode (GCM) and is used to provide both
confidentiality and data origin authentication.
NO_ENCRYPTION_AUTH_AES_GMAC_* enables authentication on input
data without encyption. Digest algorithm should be empty for this
option.
string 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

TunnelList (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly
tunnels List of transport node tunnels array of TunnelProperties Readonly

TunnelPortConfig (schema)

IP Tunnel port configuration

IP Tunnel port configuration.

Name Description Type Notes
ip_subnets IP Tunnel port subnet

IP Tunnel port (commonly referred as VTI) subnet.		 array of IPSubnet Required
Maximum items: 1
tunnel_port_id Logical route port identifier

Logical route port identifier.		 string Readonly

TunnelProperties (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
bfd Detailed information about BFD configured on interface BFDProperties Readonly
egress_interface Name of local transport interface carrying tunnel traffic

Corresponds to the interface where local_ip_address is routed.		 string Readonly
encap Tunnel encap string Readonly
Enum: STT, VXLAN, GENEVE, UNKNOWN_ENCAP
last_updated_time Time at which the Tunnel status has been fetched last time. EpochMsTimestamp Readonly
local_ip Local IP address of tunnel string Readonly
name Name of tunnel string Readonly
remote_ip Remote IP address of tunnel string Readonly
remote_node_display_name Display name of the remote transport node

Represents the display name of the remote transport node at the other end of the tunnel.		 string Readonly
remote_node_id UUID of the remote transport node string Readonly
status Status of tunnel string Readonly
Enum: UP, DOWN, UNKNOWN

TunnelStatusCount (schema)

Name Description Type Notes
bfd_diagnostic BFD Diagnostic BFDDiagnosticCount
bfd_status BFD Status BFDStatusCount
degraded_count Degraded count int
down_count Down count int
status Roll-up status string Enum: UP, DOWN, DEGRADED, UNKNOWN
up_count Up count int

TypeGroup (schema)

Name Description Type Notes
count Total count per group by field value integer Required
group_by_field_value Group By Field Value string Required
hits Hits per resource type array of object

UnassociatedVMListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_update_timestamp EpochMsTimestamp
result_count Count of results found (across all pages), set only on first page integer Readonly
results Unassociated Vitual Machine list results

List of VMs which are not associated with any NSGroup
array of VirtualMachine Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpdatePrincipalIdentityCertificateRequest (schema)

Request to update the certificate of a principal identity

Request to update the certificate of a principal identity with a new
certificate

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
certificate_id Id of the stored certificate

Id of the stored certificate		 string Required
Pattern: "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
principal_identity_id Principal Identity ID

Unique ID of the principal		 string Required
Maximum length: 255
Pattern: "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$"
resource_type Must be set to the value UpdatePrincipalIdentityCertificateRequest string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

UpgradeBundle (schema)

Name Description Type Notes
file Upgrade bundle file multipart_file Required

UpgradeBundleFetchRequest (schema)

Fetch request for fetching upgrade bundle

URL and other fetch requests of upgrade bundle

Name Description Type Notes
url URL of upgrade bundle

URL for uploading upgrade bundle		 string Required

UpgradeBundleId (schema)

Bundle id of upgrade bundle

Identifier of the upgrade bundle

Name Description Type Notes
bundle_id Bundle Id of upgrade bundle uploaded

Identifier of bundle upload		 string Readonly

UpgradeBundleInfo (schema)

Information about upgrade bundle

Information about the upgrade bundle

Name Description Type Notes
bundle_size size of upgrade bundle string Readonly
url URL of the upgrade bundle

URL for uploading upgrade bundle		 string Readonly

UpgradeBundleUploadStatus (schema)

Upload status of upgrade bundle

Upload status of upgrade bundle uploaded from url

Name Description Type Notes
detailed_status Detailed status of bundle upload

Detailed status of upgrade bundle upload		 string Readonly
percent Percent of upload completed

Percent of bundle uploaded from URL		 number Readonly
status Status of upgrade bundle upload

Current status of upgrade bundle upload		 string Readonly
Enum: UPLOADING, VERIFYING, SUCCESS, FAILED
url URL from which the bundle was uploaded

URL for uploading upgrade bundle		 string Readonly

UpgradeHistory (schema)

Name Description Type Notes
initial_version Initial Version

Version before the upgrade started		 string Required
target_version Target Version

Version being upgraded to		 string Required
timestamp Timestamp (in milliseconds since epoch) when the upgrade was performed EpochMsTimestamp Required
upgrade_status Status of the upgrade string Required
Enum: STARTED, SUCCESS, FAILED

UpgradeHistoryList (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Upgrade history list array of UpgradeHistory Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpgradePlanResetRequest (schema)

Name Description Type Notes
component_type Component type string Required

UpgradePlanSettings (schema)

Name Description Type Notes
parallel Upgrade Method to specify whether the upgrade is to be performed serially or in parallel boolean Default: "True"
pause_after_each_group Flag to indicate whether to pause the upgrade after upgrade of each group is completed boolean Default: "False"
pause_on_error Flag to indicate whether to pause the upgrade plan execution when an error occurs boolean Default: "False"

UpgradeStatus (schema)

Name Description Type Notes
ccp_status CCP upgrade status CCPUpgradeStatus Required
Readonly
component_status List of component statuses array of ComponentUpgradeStatus Required
Readonly
edge_status Edge upgrade status EdgeUpgradeStatus Required
Readonly
host_status Host upgrade status HostUpgradeStatus Required
Readonly
overall_upgrade_status Status of upgrade string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

UpgradeSummary (schema)

Name Description Type Notes
component_target_versions array of ComponentTargetVersion Readonly
system_version Current system version string Required
Readonly
target_version Target system version string Required
Readonly
upgrade_bundle_file_name Name of the last successfully uploaded upgrade bundle file string Readonly
upgrade_coordinator_updated Has upgrade coordinator been updated after upload of upgrade bundle file boolean Readonly
upgrade_coordinator_version Current version of upgrade coordinator string Required
Readonly
upgrade_status Status of upgrade string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

UpgradeUnit (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
current_version Current version of upgrade unit

This is component version e.g. if upgrade unit is of type edge, then this is edge version.		 string Readonly
display_name Name of the upgrade unit string
group Info of the group to which this upgrade unit belongs UpgradeUnitGroupInfo Readonly
id UUID of the upgrade unit

Identifier of the upgrade unit		 string Required
Readonly
metadata Metadata about upgrade unit array of KeyValuePair Readonly
type Upgrade unit type string
warnings List of warnings indicating issues with the upgrade unit that may result in upgrade failure array of string Readonly

UpgradeUnitAggregateInfo (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
current_version Current version of upgrade unit

This is component version e.g. if upgrade unit is of type edge, then this is edge version.		 string Readonly
display_name Name of the upgrade unit string
errors List of errors occurred during upgrade of this upgrade unit array of string Readonly
group Info of the group to which this upgrade unit belongs UpgradeUnitGroupInfo Readonly
id Identifier of the upgrade unit

Identifier of the upgrade unit		 string Required
Readonly
metadata Metadata about upgrade unit array of KeyValuePair Readonly
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
status Status of upgrade unit string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED
type Upgrade unit type string
warnings List of warnings indicating issues with the upgrade unit that may result in upgrade failure array of string Readonly

UpgradeUnitAggregateInfoListRequestParameters (schema)

Name Description Type Notes
component_type Component type based on which upgrade units to be filtered string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
group_id Identifier of group based on which upgrade units to be filtered string
has_errors Flag to indicate whether to return only upgrade units with errors boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
metadata Metadata about upgrade unit to filter on string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
selection_status Flag to indicate whether to return only selected, only deselected or both type of upgrade units string Enum: SELECTED, DESELECTED, ALL
Default: "ALL"
sort_ascending boolean
sort_by Field by which records are sorted string

UpgradeUnitAggregateInfoListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged collection of UpgradeUnit AggregateInfo array of UpgradeUnitAggregateInfo Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpgradeUnitGroup (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Flag to indicate whether upgrade of this group is enabled or not boolean Default: "True"
extended_configuration Extended configuration for the group array of KeyValuePair Maximum items: 100
id Unique identifier of this resource string Readonly
Sortable
parallel Upgrade method to specify whether the upgrade is to be performed in parallel or serially boolean Default: "True"
resource_type Must be set to the value UpgradeUnitGroup string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
type Component type string Required
upgrade_unit_count Count of upgrade units in the group

Number of upgrade units in the group		 int Readonly
upgrade_units List of upgrade units in the group array of UpgradeUnit Maximum items: 100

UpgradeUnitGroupAggregateInfo (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
enabled Flag to indicate whether upgrade of this group is enabled or not boolean Default: "True"
extended_configuration Extended configuration for the group array of KeyValuePair Maximum items: 100
failed_count Number of nodes in the upgrade unit group that failed upgrade int Readonly
id Unique identifier of this resource string Readonly
Sortable
parallel Upgrade method to specify whether the upgrade is to be performed in parallel or serially boolean Default: "True"
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
resource_type Must be set to the value UpgradeUnitGroupAggregateInfo string
status Upgrade status of upgrade unit group string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
type Component type string Required
upgrade_unit_count Count of upgrade units in the group

Number of upgrade units in the group		 int Readonly
upgrade_units List of upgrade units in the group array of UpgradeUnit Maximum items: 100

UpgradeUnitGroupAggregateInfoListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged collection of upgrade status for upgrade unit groups array of UpgradeUnitGroupAggregateInfo Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpgradeUnitGroupInfo (schema)

Name Description Type Notes
display_name Name of the group string Required
Readonly
id UUID of group

Identifier of group		 string Required
Readonly

UpgradeUnitGroupListRequestParameters (schema)

Name Description Type Notes
component_type Component type based on which upgrade unit groups to be filtered string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
summary Flag indicating whether to return summary boolean Default: "False"
sync Synchronize before returning upgrade unit groups

If true, synchronize with the management plane before returning upgrade unit groups		 boolean Default: "False"

UpgradeUnitGroupListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged Collection of Upgrade unit groups array of UpgradeUnitGroup Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpgradeUnitGroupStatus (schema)

Name Description Type Notes
failed_count Number of nodes in the upgrade unit group that failed upgrade int Readonly
group_id UUID of upgrade unit group

Identifier for upgrade unit group		 string Required
Readonly
group_name Upgrade unit group Name

Name of the upgrade unit group		 string Required
Readonly
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
status Upgrade status of upgrade unit group string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED
upgrade_unit_count Number of upgrade units in the group int Required
Readonly

UpgradeUnitGroupStatusListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged collection of upgrade status for upgrade unit groups array of UpgradeUnitGroupStatus Required
Readonly
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpgradeUnitList (schema)

Name Description Type Notes
list Collection of Upgrade units array of UpgradeUnit Required

UpgradeUnitListRequestParameters (schema)

Name Description Type Notes
component_type Component type based on which upgrade units to be filtered string
current_version Current version of upgrade unit based on which upgrade units to be filtered string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
group_id UUID of group based on which upgrade units to be filtered string
has_warnings Flag to indicate whether to return only upgrade units with warnings boolean Default: "False"
included_fields Comma separated list of fields that should be included in query result string
metadata Metadata about upgrade unit to filter on string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
upgrade_unit_type Upgrade unit type based on which upgrade units to be filtered string

UpgradeUnitListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged Collection of Upgrade units array of UpgradeUnit Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpgradeUnitStatus (schema)

Name Description Type Notes
display_name Name of upgrade unit string Required
Readonly
errors List of errors occurred during upgrade of this upgrade unit array of string Readonly
id UUID of upgrade unit

Identifier of upgrade unit		 string Required
Readonly
percent_complete Indicator of upgrade progress in percentage number Required
Readonly
status Status of upgrade unit string Required
Readonly
Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

UpgradeUnitStatusListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Paged Collection of upgrade units status array of UpgradeUnitStatus Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

UpgradeUnitTypeStats (schema)

Name Description Type Notes
node_count Number of nodes int Required
Readonly
node_with_issues_count Number of nodes with issues that may cause upgrade failure int Readonly
type Type of upgrade unit string Required
Readonly
version Version of the upgrade unit string Required
Readonly

UpgradeUnitTypeStatsList (schema)

Name Description Type Notes
results List of upgrade unit type stats array of UpgradeUnitTypeStats Readonly

UpgradeUnitsStatsRequestParameters (schema)

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
sync Synchronize before returning upgrade unit stats

If true, synchronize with the management plane before returning upgrade unit stats		 boolean Default: "False"

Uplink (schema)

Object to identify an uplink based on its type and name

Name Description Type Notes
uplink_name Name of this uplink string Required
uplink_type Type of the uplink string Required
Enum: PNIC, LAG

UplinkHostSwitchProfile (schema)

Profile for uplink policies

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
lags list of LACP group array of Lag Maximum items: 64
mtu Maximum Transmission Unit used for uplinks int Minimum: 1280
Maximum: 9000
Default: "1600"
named_teamings List of named uplink teaming policies that can be used by logical switches array of NamedTeamingPolicy Maximum items: 32
overlay_encap The protocol used to encapsulate overlay traffic string Enum: VXLAN, GENEVE
Default: "GENEVE"
required_capabilities array of string Readonly
resource_type Must be set to the value UplinkHostSwitchProfile HostSwitchProfileType Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
teaming Default TeamingPolicy associated with this UplinkProfile TeamingPolicy Required
transport_vlan VLAN used for tagging Overlay traffic of associated HostSwitch VlanID Default: "0"

UpmEntityType (schema)

Supported Entity Types

All entity types supported.

Name Description Type Notes
UpmEntityType Supported Entity Types

All entity types supported.		 string Enum: LogicalPort, LogicalSwitch, NSGroup

UrlAlias (schema)

Url Alias

Short name or alias of a url. It is used to represent the url.

Name Description Type Notes
alias Url Alias Name

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).		 string Maximum length: 255
query Search query of the search api, if any

Search query to be applied, if any. If query string is not provided, it will be ignored.		 string Maximum length: 1024
url Url

Url to fetch data from.		 string Required
Maximum length: 1024

UrpfMode (schema)

Unicast Reverse Path Forwarding mode

Name Description Type Notes
UrpfMode Unicast Reverse Path Forwarding mode string Enum: NONE, STRICT

UserGroupType (schema)

Supported groups a principal identity can belong to.

Name Description Type Notes
UserGroupType Supported groups a principal identity can belong to. string Enum: read_only_api_users, read_write_api_users, superusers, undefined

UserInfo (schema)

Authenticated User Info

Name Description Type Notes
roles Permissions array of NsxRole Required
Readonly
user_name User Name string Required
Readonly

UsernamePasswordLoginCredential (schema)

A login credential specifying a username and password

Name Description Type Notes
credential_type Must be set to the value UsernamePasswordLoginCredential string Required
password The authentication password for login string
thumbprint Thumbprint of the login server string Pattern: "^(([0-9A-Fa-f]{2}[:])+([0-9A-Fa-f]{2}))?$"
username The username for login string

VIPSubnet (schema)

Name Description Type Notes
active_vip_addresses IPv4 Addresses which will be owned by uplink on active node.

Array of IP address subnets which will be used as floating IP addresses. | These IPs will move and will be owned by Active node.		 array of IPv4Address Required
Minimum items: 1
Maximum items: 1
prefix_length Subnet Prefix Length integer Required
Minimum: 1
Maximum: 31

VerifiableAsymmetricLoginCredential (schema)

Name Description Type Notes
asymmetric_credential Asymmetric login credential string
credential_key Credential key string
credential_type Must be set to the value VerifiableAsymmetricLoginCredential string Required
credential_verifier Credential verifier string

VersionList (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
acceptable_versions List of component versions array of string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
resource_type Must be set to the value VersionList string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

VersionedDeploymentSpec (schema)

Versioned DeploymentSpec contains vibs and ofv urls for specific version of fabric module and host type and host version.

Name Description Type Notes
host_type type of host string Required
Enum: ESXI, RHELKVM, UBUNTUKVM, RHELCONTAINER, RHELSERVER, UBUNTUSERVER, CENTOSSERVER, CENTOSKVM
host_version version of the host string Required
package_stores Package store contains package url and bulletin_ids array of PackageStore Required
service_vm_ovf_url list of service vm ovf urls array of string

VidmInfo (schema)

Vidm Info

Name Description Type Notes
display_name User's Full Name Or User Group's Display Name string Required
Readonly
name Username Or Groupname string Required
Readonly
type Type string Required
Readonly
Enum: remote_user, remote_group

VidmInfoListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results List results array of VidmInfo Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

VidmInfoSearchRequestParameters (schema)

Vidm information search request parameters

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
search_string Search string to search for.

This is a substring search that is case insensitive.
string Required
sort_ascending boolean
sort_by Field by which records are sorted string

View (schema)

Dashboard View

Describes the configuration of a view to be displayed on the dashboard.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
exclude_roles Roles to which the shared view is not visible

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.		 string Maximum length: 1024
id Unique identifier of this resource string Readonly
Sortable
include_roles Roles to which the shared view is visible

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.		 string Maximum length: 1024
resource_type Must be set to the value View string
shared Share the view with other users

Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.		 boolean Default: "False"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the view

Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.		 int Default: "10000"
widgets Widgets

Array of widgets that are part of the view.		 array of WidgetItem Required
Minimum items: 0

VifAttachmentContext (schema)

Name Description Type Notes
allocate_addresses A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch. string Enum: IpPool, MacPool, Both, None
app_id ID used to identify/look up a child VIF behind a parent VIF

An application ID used to identify / look up a child VIF
behind a parent VIF. Only effective when vif_type is CHILD.
string
parent_vif_id VIF ID of the parent VIF if vif_type is CHILD string
resource_type Must be set to the value VifAttachmentContext string Required
traffic_tag Tag used for the traffic between this VIF and parent VIF

Current we use VLAN id as the traffic tag.
Only effective when vif_type is CHILD.
Each logical port inside a container must have a
unique traffic tag. If the traffic_tag is not
unique, no error is generated, but traffic will
not be delivered to any port with a non-unique tag.
int
transport_node_uuid The UUID of the transport node

Only effective when vif_type is INDEPENDENT.
Each logical port inside a bare metal server
or container must have a transport node UUID.
We use transport node ID as transport node UUID.
string
vif_type Type of the VIF attached to logical port string Required
Enum: PARENT, CHILD, INDEPENDENT

VifListRequestParameters (schema)

VirtualNetworkInterface list request parameters.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
host_id Id of the host where this vif is located. string
included_fields Comma separated list of fields that should be included in query result string
lport_attachment_id LPort Attachment Id of the virtual network interface. string
owner_vm_id External id of the virtual machine. string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string
vm_id External id of the virtual machine. string

VirtualMachine (schema)

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
compute_ids 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'] array of string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id Current external id of this virtual machine in the system. string Required
host_id Id of the host in which this virtual machine exists. string
local_id_on_host Id of the vm unique within the host. string Required
power_state Current power state of this virtual machine in the system. string Required
Enum: VM_RUNNING, VM_STOPPED, VM_SUSPENDED, UNKNOWN
resource_type Must be set to the value VirtualMachine string
source Reference of the Host or Public Cloud Gateway that reported the VM ResourceReference
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
type Virtual Machine type; Edge, Service VM or other. string Required
Readonly
Enum: EDGE, SERVICE, REGULAR

VirtualMachineListRequestParameters (schema)

VirtualMachine list request parameters.

Name Description Type Notes
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
display_name Display Name of the virtual machine string
external_id External id of the virtual machine string
host_id Id of the host where this vif is located string
included_fields Comma separated list of fields that should be included in query result string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending boolean
sort_by Field by which records are sorted string

VirtualMachineListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results VirtualMachine list results array of VirtualMachine Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

VirtualNetworkInterface (schema)

Name Description Type Notes
_last_sync_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
description Description of this resource string Maximum length: 1024
Sortable
device_key Device key of the virtual network interface. string Required
device_name Device name of the virtual network interface. string
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
external_id External Id of the virtual network inferface. string Required
host_id Id of the host on which the vm exists. string Required
ip_address_info IP Addresses of the the virtual network interface, from various sources. array of IpAddressInfo
lport_attachment_id LPort Attachment Id of the virtual network interface. string
mac_address MAC address of the virtual network interface. string Required
owner_vm_id Id of the vm to which this virtual network interface belongs. string Required
resource_type Must be set to the value VirtualNetworkInterface string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
vm_local_id_on_host Id of the vm unique within the host. string Required

VirtualNetworkInterfaceListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results VirtualNetworkInterface list results array of VirtualNetworkInterface Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

VirtualServerIpProtocol (schema)

IP protocol of virtual server

Assigned Internet protocol in IP header, TCP and UDP are supported.

Name Description Type Notes
VirtualServerIpProtocol IP protocol of virtual server

Assigned Internet protocol in IP header, TCP and UDP are supported.
string Enum: TCP, UDP

VirtualServiceInstance (schema)

Custom Instance of a service

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).

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
on_failure_policy On Failure Policy

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.		 string Enum: ALLOW, BLOCK
resource_type Must be set to the value VirtualServiceInstance ServiceInstanceResourceType Required
service_id Service Id

The Service to which the service instance is associated.		 string Readonly
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
transport_type Transport Type

Transport to be used by this service instance for deploying the Service-VM.		 string Required
Enum: L2_BRIDGE, L3_ROUTED

VlanID (schema)

Virtual Local Area Network Identifier

Name Description Type Notes
VlanID Virtual Local Area Network Identifier integer Minimum: 0
Maximum: 4094

VlanMirrorSource (schema)

Name Description Type Notes
resource_type Must be set to the value VlanMirrorSource MirrorSourceResourceType Required
vlan_ids Source VLAN ID list array of VlanID Required
Minimum items: 1

VlanTrunkSpec (schema)

VLAN trunk range specification

VlanTrunkspec is used for specifying trunk VLAN id ranges.

Name Description Type Notes
vlan_ranges Trunk VLAN id ranges array of TrunkVlanRange Required

VmNicInfo (schema)

Set of NIC information of a VM

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.

Name Description Type Notes
nic_infos Set of NIC information of a VM

Set of information of a VM on the network interfaces present on the partner appliance that needs to be configured by the NSX Manager.		 array of NicInfo Required

VmkToLogicalSwitchMapping (schema)

Holds VMkernal to logical switch mapping. This will be used for network migration.

Name Description Type Notes
dest_network_id The ID of the NSX logical switch to which source vmkernal interface needs to be migrated to.

Only VLAN type of logical switch can be specified here, as migration operation is only supported for these types.		 string Required
src_interface_id The ID (for example, vmk0) of the vmkernal interface on ESX to migrate. string Required

VnetStats (schema)

Virtual Network statistics

Stores statistics of the number of MANAGED and UNMANAGED virtual networks.

Name Description Type Notes
managed Managed virtual networks

The number of virtual networks with status MANAGED.		 integer Readonly
unmanaged Unmanaged virtual networks

The number of vitual networks with status UNMANAGED.		 integer Readonly

VniPool (schema)

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
ranges VNI range list results array of VniRange Required
resource_type Must be set to the value VniPool string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

VniPoolListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results VNI pool list results array of VniPool Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

VniRange (schema)

A range of virtual network identifiers (VNIs)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
end End value of vni range

End value for vni range to be used for virtual networks		 integer Required
Minimum: 5000
Maximum: 16777215
start Start value of vni range

Start value for vni range to be used for virtual networks		 integer Required
Minimum: 5000
Maximum: 16777215

VpcStats (schema)

VPC statistics

Stores statistics of the number of MANAGED and UNMANAGED VPCs.

Name Description Type Notes
managed Managed VPCs

The number of VPCs with status MANAGED.		 integer Readonly
unmanaged Unmanaged VPCs

The number of VPCs with status UNMANAGED.		 integer Readonly

VpnRoutingTableState (schema)

Public Cloud Routing Table State

State of a public cloud routing table from VPN point of view

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
account_id Identifier for account based on which routing tables are to be filtered string Required
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Public Cloud Routing Table Identifier

The identifier of the public cloud routing table
string Required
managed_for_vpn NSX Managed Routing Table

Flag to identify whether the routing table is actually managed by NSX for VPN		 boolean Required
network_id Identifier for a network based on which the list are to be filtered string Required
reason_for_not_managed Unmanaged Table Reason

Reason why a routing table is not being managed for VPN		 string Enum: RT_CONTAINS_MGMT_SUBNET, RT_CONTAINS_UPLINK_SUBNET, RT_CONTAINS_MGMT_UPLINK_SUBNET, NONSELECTED
resource_type Must be set to the value VpnRoutingTableState string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

VpnRoutingTableStateListResult (schema)

List of Public Cloud Routing State

List of public cloud routing tables and their state. It contains the state information relevant for VPN.

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Public Cloud Routing State Tables

Set of public cloud routing tables and their state		 array of VpnRoutingTableState Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

VpnRoutingTablesStateListRequestParameters (schema)

These parameters can be used to filter the list of routing table states.
Multiple parameters can be given as input. Different parameters are implicitly 'AND'ed.

Name Description Type Notes
account_id Identifier for account based on which routing tables are to be filtered string
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result string
managed_for_vpn Flag to identify whether the routing table is actually managed by NSX for VPN boolean
network_id Identifier for a network based on which the list is to be filtered string
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
reason_for_not_managed Reason why a routing table is not being managed for VPN string Enum: RT_CONTAINS_MGMT_SUBNET, RT_CONTAINS_UPLINK_SUBNET, RT_CONTAINS_MGMT_UPLINK_SUBNET, NONSELECTED
sort_ascending boolean
sort_by Field by which records are sorted string

VsphereClusterNodeVMDeploymentConfig (schema)

Deployment config on the Vsphere platform

Config for deploying a cluster node VM through a Vcenter server

Name Description Type Notes
allow_ssh_root_login Allow root SSH logins.

If true, the root user will be allowed to log into the VM.
Allowing root SSH logins is not recommended for security reasons.
boolean Default: "False"
compute_id Cluster identifier or resourcepool identifier

The cluster node VM will be deployed on the specified cluster or
resourcepool for specified VC server.
string Required
default_gateway_addresses Default gateway for the VM

The default gateway for the VM to be deployed must be specified if all
the other VMs it communicates with are not in the same subnet.
Do not specify this field and management_port_subnets to use DHCP.
Note: only single IPv4 default gateway address is supported and it
must belong to management network.
IMPORTANT: Controllers deployed using DHCP are currently not supported,
so this parameter should be specified for deploying Controllers.
array of IPAddress Minimum items: 1
Maximum items: 1
dns_servers DNS servers.

List of DNS servers.
If DHCP is used, the default DNS servers associated with
the DHCP server will be used instead.
array of IPv4Address
enable_ssh Enable SSH.

If true, the SSH service will automatically be started on the VM.
Enabling SSH service is not recommended for security reasons.
boolean Default: "False"
host_id Host identifier

The cluster node VM will be deployed on the specified host in the
specified VC server within the cluster if host_id is specified.
Note: User must ensure that storage and specified networks are
accessible by this host.
string
hostname Host name or FQDN for the VM

Desired host name/FQDN for the VM to be deployed		 string Required
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])?)*?$"
management_network_id Portgroup identifier for management network connectivity

Distributed portgroup identifier to which the management vnic of
cluster node VM will be connected.
string Required
management_port_subnets Port subnets for management port

IP Address and subnet configuration for the management port.
Do not specify this field and default_gateway_addresses to use DHCP.
Note: only one IPv4 address is supported for the management port.
IMPORTANT: Controllers deployed using DHCP are currently not supported,
so this parameter should be specified for deploying Controllers.
array of IPSubnet Minimum items: 1
Maximum items: 1
ntp_servers NTP servers.

List of NTP servers.
To use hostnames, a DNS server must be defined. If not using DHCP,
a DNS server should be specified under dns_servers.
array of HostnameOrIPv4Address
placement_type Must be set to the value VsphereClusterNodeVMDeploymentConfig string Required
Enum: VsphereClusterNodeVMDeploymentConfig
storage_id Storage/datastore identifier

The cluster node VM will be deployed on the specified datastore in
the specified VC server. User must ensure that storage is accessible
by the specified cluster/host.
string Required
vc_id Vsphere compute identifier for identifying VC server

The VC-specific identifiers will be resolved on this VC, so all other
identifiers specified in the config must belong to this Vcenter server.
string Required

VsphereDeploymentConfig (schema)

The Vsphere deployment configuration determines where to deploy the edge
node. It contains settings that are applied during install time.
If using DHCP, you must leave the following fields unset: search_domains,
management_port_subnets, dns_servers and default_gateway_addresses.

Name Description Type Notes
allow_ssh_root_login Allow root SSH logins.

Allowing root SSH logins is not recommended for security reasons.
boolean Default: "False"
compute_id Cluster identifier or resourcepool identifier for specified vcenter server.

The edge node vm will be deployed on the specified cluster or resourcepool.
Note - all the hosts must have nsx fabric prepared in the specified cluster.
string Required
data_network_ids Portgroup or logical switch identifiers for datapath connectivity.

List of distributed portgroup or VLAN logical identifiers to which the
datapath serving vnics of edge node vm will be connected.
array of string Required
Minimum items: 3
Maximum items: 3
default_gateway_addresses Default gateway for the node.

The default gateway for edge node must be specified if all the nodes it
communicates with are not in the same subnet.
Note: Only single IPv4 default gateway address is supported and it must
belong to management network.
array of IPAddress Minimum items: 1
Maximum items: 1
dns_servers DNS servers.

List of DNS servers.
array of IPAddress
enable_ssh Enable SSH.

Enabling SSH service is not recommended for security reasons.
boolean Default: "False"
host_id Host identifier in the specified vcenter server.

The edge node vm will be deployed on the specified Host within the cluster
if host_id is specified.
Note - User must ensure that storage and specified networks are accessible by this host.
string
hostname Host name or FQDN for edge node. string Required
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])?)*?$"
management_network_id Portgroup or logical switch identifier for management network connectivity.

Distributed portgroup identifier to which the management vnic of edge node vm
will be connected. This portgroup must have connectivity with MP and CCP. A
VLAN logical switch identifier may also be specified.
string Required
management_port_subnets Port subnets for management port. Only one IPv4 Address is supported.

IP Address and subnet configuration for the management port. Note:
only one IPv4 address is supported for the management port.
array of IPSubnet Minimum items: 1
Maximum items: 1
ntp_servers NTP servers.

List of NTP servers.
array of IPAddress
placement_type Must be set to the value VsphereDeploymentConfig string Required
Enum: VsphereDeploymentConfig
search_domains Search domain names.

List of domain names that are used to complete unqualified host names.
array of string
storage_id Storage/datastore identifier in the specified vcenter server.

The edge node vm will be deployed on the specified datastore. User must ensure
that storage is accessible by the specified cluster/host.
string Required
vc_id Vsphere compute identifier for identifying the vcenter server.

The vc specific identifiers will be resolved on this VC.
So all other identifiers specified here must belong to this vcenter server.
string Required

VtepCsvListResult (schema)

Name Description Type Notes
file_name File name

File name set by HTTP server if API returns CSV result as a file.		 string
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
results array of VtepTableCsvRecord

VtepLabelPool (schema)

A collection of ranges of virtual tunnel endpoint labels

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set		 string Maximum length: 255
Sortable
id Unique identifier of this resource string Readonly
Sortable
pool_usage Pool usage statistics VtepLabelPoolUsage Readonly
ranges Array of ranges for virtual tunnel endpoint labels array of VtepLabelRange Required
resource_type Must be set to the value VtepLabelPool string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30

VtepLabelPoolListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results Virtual tunnel endpoint label pool list results array of VtepLabelPool Required
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly

VtepLabelPoolUsage (schema)

Pool usage statistics in a pool

Name Description Type Notes
allocated_ids Total number of allocated IDs in a pool integer Readonly
free_ids Total number of free IDs in a pool integer Readonly
total_ids Total number of IDs in a pool integer Readonly

VtepLabelRange (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
end Virtual tunnel endpoint label range end

End value for virtual tunnel endpoint label range		 integer Required
Minimum: 1
Maximum: 131071
start Virtual tunnel endpoint label range start

Start value for virtual tunnel endpoint label range		 integer Required
Minimum: 1
Maximum: 131071

VtepListResult (schema)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string Readonly
last_update_timestamp Timestamp when the data was last updated; unset if data source has never updated the data. EpochMsTimestamp Readonly
logical_switch_id The id of the logical Switch string Required
Readonly
result_count Count of results found (across all pages), set only on first page integer Readonly
results array of VtepTableEntry
sort_ascending If true, results are sorted in ascending order boolean Readonly
sort_by Field by which records are sorted string Readonly
transport_node_id Transport node identifier string Readonly

VtepTableCsvRecord (schema)

Name Description Type Notes
segment_id The segment Id string
vtep_ip The virtual tunnel endpoint IP address IPAddress
vtep_label The virtual tunnel endpoint label integer Required
vtep_mac_address The virtual tunnel endpoint MAC address string Required

VtepTableEntry (schema)

Name Description Type Notes
segment_id The segment Id string
vtep_ip The virtual tunnel endpoint IP address IPAddress
vtep_label The virtual tunnel endpoint label integer
vtep_mac_address The virtual tunnel endpoint MAC address string

WeeklyBackupSchedule (schema)

Schedule to specify day of the week and time to take automated backup

Name Description Type Notes
days_of_week Days of week when backup is taken. 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday ... array of integer Required
Minimum items: 1
Maximum items: 7
hour_of_day Time of day when backup is taken integer Required
Minimum: 0
Maximum: 23
minute_of_day Time of day when backup is taken integer Required
Minimum: 0
Maximum: 59
resource_type Must be set to the value WeeklyBackupSchedule string Required
Enum: WeeklyBackupSchedule, IntervalBackupSchedule

WeeklyTelemetrySchedule (schema)

Name Description Type Notes
day_of_week Day of week on which data will be collected

Day of week on which data will be collected. Specify one of SUNDAY through SATURDAY.
string Required
Enum: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
frequency_type Must be set to the value WeeklyTelemetrySchedule string Required
hour_of_day Hour at which data will be collected

Hour at which data will be collected. Specify a value between 0 through 23.
integer Required
Minimum: 0
Maximum: 23
minutes Minute at which data will be collected

Minute at which data will be collected. Specify a value between 0 through 59.
integer Minimum: 0
Maximum: 59
Default: "0"

WhiteListProvisionType (schema)

Ways to provide white listed addresses for SpoofGuard

Name Description Type Notes
WhiteListProvisionType Ways to provide white listed addresses for SpoofGuard string Enum: LPORT_BINDINGS, LSWITCH_BINDINGS

WidgetConfiguration (schema)

Dashboard Widget Configuration

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.

Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.		 array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

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.		 int Readonly
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
datasources Array of Datasource Instances with their relative urls

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.		 array of Datasource Minimum items: 0
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget.		 string Required
Maximum length: 255
drilldown_id Id of drilldown widget

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.		 string Maximum length: 255
footer Footer
id Unique identifier of this resource string Readonly
Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.		 boolean Default: "False"
resource_type Must be set to the value WidgetConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration
Maximum length: 255
shared Visiblity of widgets to other users

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.		 boolean Deprecated
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.		 int Deprecated

WidgetItem (schema)

Widget held by MultiWidgetConfiguration or Container or a View

Represents a reference to a widget that is held by a container or a multi-widget or a View.

Name Description Type Notes
label Label of the the report

Applicable for 'DonutConfiguration' and 'StatsConfiguration' reports only. If label is not specified, then it defaults to the label of the donut or stats report.		 Label
weight Weightage or placement of the widget or container

Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order.		 int Default: "10000"
widget_id Id of the widget configuration

Id of the widget configuration that is held by a multi-widget or a container or a view.		 string Required
Maximum length: 255

X509Certificate (schema)

Name Description Type Notes
dsa_public_key_g One of the DSA cryptogaphic algorithm's strength parameters, base string Readonly
dsa_public_key_p One of the DSA cryptogaphic algorithm's strength parameters, prime string Readonly
dsa_public_key_q One of the DSA cryptogaphic algorithm's strength parameters, sub-prime string Readonly
dsa_public_key_y One of the DSA cryptogaphic algorithm's strength parameters string Readonly
is_ca True if this is a CA certificate boolean Required
Readonly
is_valid True if this certificate is valid boolean Required
Readonly
issuer the certificate issuers complete distinguished name string Required
Readonly
issuer_cn the certificate issuer's common name string Required
Readonly
not_after the time in epoch milliseconds at which the certificate becomes invalid EpochMsTimestamp Required
Readonly
not_before the time in epoch milliseconds at which the certificate becomes valid EpochMsTimestamp Required
Readonly
public_key_algo Cryptographic algorithm used by the public key for data encryption string Required
Readonly
Enum: RSA, DSA
public_key_length size measured in bits of the public/private keys used in a cryptographic algorithm integer Required
Readonly
rsa_public_key_exponent An RSA public key is made up of the modulus and the public exponent. Exponent is a power number string Readonly
rsa_public_key_modulus An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number string Readonly
serial_number certificate's serial number string Required
Readonly
signature the signature value(the raw signature bits) used for signing and validate the cert string Required
Readonly
signature_algorithm the algorithm used by the Certificate Authority to sign the certificate string Required
Readonly
subject the certificate owners complete distinguished name string Required
Readonly
subject_cn the certificate owner's common name string Required
Readonly
version Certificate version (default v1) string Required
Readonly

X509Crl (schema)

A CRL is a time-stamped list identifying revoked certificates.

Name Description Type Notes
crl_entries list of X509CrlEntry array of X509CrlEntry Readonly
issuer Issuer's distinguished name(DN) string Readonly
next_update Next update time for the CRL string Readonly
version CRL's version number either 1 or 2 string Readonly

X509CrlEntry (schema)

Each revoked certificate is identified in a CRL by its certificate serial number.

Name Description Type Notes
revocation_date Revocation date string Readonly
serial_number the revoked certificate's serial number string Readonly

XForwardedForType (schema)

x-forwarded-for type

Name Description Type Notes
XForwardedForType x-forwarded-for type string Enum: INSERT, REPLACE



API Type Schemas

Request and response bodies for API Methods are specified using the proposed JSON Schema format (revision 03) documented at http://json-schema.org/ . All data returned by API methods references the schema being used through the an attribute of the top-level object named "_schema". These will refer to the schema definitions provided as described in the Embedded API Documentation methods of the API. The schemas make use of JSON referencing to reduce restatement of the same schema information in multiple places.

JsonSchema

As defined in http://tools.ietf.org/html/draft-zyp-json-schema-03.

ALGTypeNSService (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "ALGTypeNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ALGTypeNSService"
  }, 
  "properties": {
    "alg": {
      "enum": [
        "ORACLE_TNS", 
        "FTP", 
        "SUN_RPC_TCP", 
        "SUN_RPC_UDP", 
        "MS_RPC_TCP", 
        "MS_RPC_UDP", 
        "NBNS_BROADCAST", 
        "NBDG_BROADCAST", 
        "TFTP"
      ], 
      "required": true, 
      "title": "The Application Layer Gateway (ALG) protocol", 
      "type": "string"
    }, 
    "destination_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "title": "The destination_port cannot be empty and must be a single value.", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "title": "Source ports", 
      "type": "array"
    }
  }, 
  "title": "An NSService element that represents an ALG protocol", 
  "type": "object"
}

AcceptableComponentVersion (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "VersionList"+
  }, 
  "id": "AcceptableComponentVersion", 
  "module_id": "VersionWhitelist", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "acceptable_versions": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of component versions", 
      "type": "array"
    }, 
    "component_type": {
      "enum": [
        "HOST", 
        "EDGE", 
        "CCP", 
        "MP"
      ], 
      "required": true, 
      "title": "Node type", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AcceptableComponentVersionList (type) 

{
  "additionalProperties": false, 
  "id": "AcceptableComponentVersionList", 
  "module_id": "VersionWhitelist", 
  "properties": {
    "results": {
      "items": {
        "$ref": "AcceptableComponentVersion"+
      }, 
      "required": true, 
      "title": "Acceptable version whitelist for different components", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ActionableResource (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ActionableResource", 
  "module_id": "ClusterRestore", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "A resource reference on which actions can be performed"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Resources managed during restore process", 
  "type": "object"
}

ActionableResourceListRequestParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ActionableResourceListRequestParameters", 
  "module_id": "ClusterRestore", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "instruction_id": {
      "required": true, 
      "title": "Id of the instruction set whose instructions are to be returned", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ActionableResourceListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ActionableResourceListResult", 
  "module_id": "ClusterRestore", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ActionableResource"+
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AddClusterNodeAction (type) 

{
  "id": "AddClusterNodeAction", 
  "module_id": "ClusterManagement", 
  "properties": {
    "action": {
      "enum": [
        "add_cluster_node"
      ], 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

AddClusterNodeSpec (type) 

{
  "id": "AddClusterNodeSpec", 
  "module_id": "ClusterManagement", 
  "properties": {
    "controller_role_config": {
      "$ref": "AddControllerNodeSpec"+
    }, 
    "display_name": {
      "title": "Display name for the node", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": false, 
      "title": "External identifier of the node", 
      "type": "string"
    }, 
    "mgr_role_config": {
      "$ref": "AddManagementNodeSpec"+
    }
  }, 
  "type": "object"
}

AddControllerNodeSpec (type) 

{
  "additionalProperties": false, 
  "id": "AddControllerNodeSpec", 
  "module_id": "ClusterManagement", 
  "properties": {
    "clustering_params": {
      "$ref": "ClusteringInfo"+, 
      "description": "The details of the controller node required for cluster initialization or joining to an existing cluster.  If this property is set, the node will be added to an existing cluster or used to create a new cluster.  Otherwise no clustering operation/s will be performed.", 
      "required": false, 
      "title": "Clustering parameters for the node"
    }, 
    "control_plane_server_certificate": {
      "deprecated": true, 
      "description": "Deprecated. Do not supply a value for this property.", 
      "type": "string"
    }, 
    "host_msg_client_info": {
      "$ref": "MsgClientInfo"+, 
      "required": true
    }, 
    "mpa_msg_client_info": {
      "$ref": "MsgClientInfo"+, 
      "required": true
    }, 
    "node_id": {
      "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.", 
      "required": false, 
      "title": "Internal identifier of the node", 
      "type": "string"
    }, 
    "type": {
      "enum": [
        "AddControllerNodeSpec"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "must be set to AddControllerNodeSpec", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AddManagementNodeSpec (type) 

{
  "additionalProperties": false, 
  "id": "AddManagementNodeSpec", 
  "module_id": "ClusterManagement", 
  "properties": {
    "cert_thumbprint": {
      "readonly": false, 
      "title": "The certificate thumbprint of the remote node.", 
      "type": "string"
    }, 
    "mpa_msg_client_info": {
      "$ref": "MsgClientInfo"+
    }, 
    "password": {
      "readonly": false, 
      "required": true, 
      "sensitive": true, 
      "title": "The password to be used to authenticate with the remote node.", 
      "type": "string"
    }, 
    "remote_address": {
      "$ref": "IPAddress"+, 
      "readonly": false, 
      "required": true, 
      "title": "The host address of the remote node to which to send this join request."
    }, 
    "type": {
      "enum": [
        "AddManagementNodeSpec"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "must be set to AddManagementNodeSpec", 
      "type": "string"
    }, 
    "user_name": {
      "readonly": false, 
      "required": true, 
      "title": "The username to be used to authenticate with the remote node.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AddressFamilyType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "IPV4_UNICAST", 
    "VPNV4_UNICAST"
  ], 
  "id": "AddressFamilyType", 
  "module_id": "Routing", 
  "title": "Type of Address Family", 
  "type": "string"
}

AdvanceClusterRestoreInput (type) 

{
  "id": "AdvanceClusterRestoreInput", 
  "module_id": "ClusterRestore", 
  "properties": {
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique id of an instruction (as returned by the GET /restore/status\ncall) for which input is to be provided\n", 
      "type": "string"
    }, 
    "resources": {
      "items": {
        "$ref": "SelectableResourceReference"+
      }, 
      "required": true, 
      "title": "List of resources for which the instruction is applicable.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvanceClusterRestoreRequest (type) 

{
  "id": "AdvanceClusterRestoreRequest", 
  "module_id": "ClusterRestore", 
  "properties": {
    "data": {
      "items": {
        "$ref": "AdvanceClusterRestoreInput"+
      }, 
      "required": true, 
      "title": "List of instructions and their associated data", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvertiseRule (type) 

{
  "additionalProperties": false, 
  "id": "AdvertiseRule", 
  "module_id": "Routing", 
  "properties": {
    "action": {
      "default": "ALLOW", 
      "description": "ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.", 
      "enum": [
        "DENY", 
        "ALLOW"
      ], 
      "required": false, 
      "title": "Action to ALLOW or DENY advertisement of routes", 
      "type": "string"
    }, 
    "description": {
      "maxLength": 1024, 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "display_name": {
      "maxLength": 255, 
      "required": false, 
      "title": "Display name", 
      "type": "string"
    }, 
    "networks": {
      "items": {
        "$ref": "IPv4CIDRBlock"+
      }, 
      "required": true, 
      "title": "network(CIDR) to be routed", 
      "type": "array"
    }, 
    "rule_filter": {
      "$ref": "AdvertisementRuleFilter"+, 
      "required": false, 
      "title": "Rule filter for the advertise rule"
    }
  }, 
  "type": "object"
}

AdvertiseRuleList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AdvertiseRuleList", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rules": {
      "default": [], 
      "items": {
        "$ref": "AdvertiseRule"+
      }, 
      "minItems": 0, 
      "required": false, 
      "title": "List of advertisement rules", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvertisedNetwork (type) 

{
  "additionalProperties": false, 
  "id": "AdvertisedNetwork", 
  "module_id": "L3", 
  "properties": {
    "advertised_route_type": {
      "description": "Advertise network route type on TIER0 LR", 
      "readonly": true, 
      "required": false, 
      "title": "Advertised route type of network", 
      "type": "string"
    }, 
    "is_advertised": {
      "default": false, 
      "description": "Flag to denote advertisement status of network to TIER0 LR.", 
      "readonly": true, 
      "required": false, 
      "title": "Advertisement status of network", 
      "type": "boolean"
    }, 
    "network": {
      "$ref": "IPv4Address"+, 
      "description": "Advertised network address.", 
      "readonly": true, 
      "required": true, 
      "title": "Advertised Network"
    }, 
    "resource": {
      "$ref": "ResourceReference"+, 
      "description": "Resource which has registered network.", 
      "readonly": true, 
      "required": true, 
      "title": "Resource of network"
    }
  }, 
  "type": "object"
}

AdvertisedNetworksListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AdvertisedNetworksListParameters", 
  "module_id": "L3", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Advertised networks list parameters", 
  "type": "object"
}

AdvertisedNetworksListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AdvertisedNetworksListResult", 
  "module_id": "L3", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of networks which advertised to TIER0 from TIER1 LR", 
      "items": {
        "$ref": "AdvertisedNetwork"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of advertised networks", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AdvertisementConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AdvertisementConfig", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "advertise_lb_snat_ip": {
      "default": false, 
      "required": false, 
      "title": "Flag to advertise all lb SNAT ips", 
      "type": "boolean"
    }, 
    "advertise_lb_vip": {
      "default": false, 
      "required": false, 
      "title": "Flag to advertise lb vip", 
      "type": "boolean"
    }, 
    "advertise_nat_routes": {
      "default": false, 
      "required": false, 
      "title": "Flag to advertise all routes of nat", 
      "type": "boolean"
    }, 
    "advertise_nsx_connected_routes": {
      "default": false, 
      "required": false, 
      "title": "Flag to advertise all connected routes", 
      "type": "boolean"
    }, 
    "advertise_static_routes": {
      "default": false, 
      "required": false, 
      "title": "Flag to advertise all static routes", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable this configuration", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AdvertisementRuleFilter (type) 

{
  "additionalProperties": false, 
  "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.", 
  "id": "AdvertisementRuleFilter", 
  "module_id": "Routing", 
  "properties": {
    "match_route_types": {
      "items": {
        "$ref": "AdvertisementRuleFilterRouteType"+
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Array of route types to filter routes", 
      "type": "array"
    }, 
    "prefix_operator": {
      "default": "GE", 
      "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.", 
      "enum": [
        "GE", 
        "EQ"
      ], 
      "required": true, 
      "title": "Prefix operator to apply on networks", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AdvertisementRuleFilterRouteType (type) 

{
  "additionalProperties": false, 
  "description": "Route types to filter the routes advertised by TIER1 LR. The ANY type filters all routes advertised by TIER1. The STATIC type filters STATIC routes advertised by TIER1. The NSX_CONNECTED type filters routes conrresponding to downlink 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 correspoding to LB SNAT rules advertised by TIER1.", 
  "enum": [
    "ANY", 
    "STATIC", 
    "NSX_CONNECTED", 
    "T1_NAT", 
    "T1_LB_VIP", 
    "T1_LB_SNAT"
  ], 
  "id": "AdvertisementRuleFilterRouteType", 
  "module_id": "Routing", 
  "type": "string"
}

AgentInfo (type) 

{
  "additionalProperties": false, 
  "description": "Information on agent download link and install command.", 
  "id": "AgentInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "agent_download_link": {
      "required": false, 
      "title": "Link to Download Agent", 
      "type": "string"
    }, 
    "agent_install_command": {
      "required": false, 
      "title": "Command to Install Agent", 
      "type": "string"
    }, 
    "agent_os_type": {
      "required": false, 
      "title": "Agent OS Type", 
      "type": "string"
    }
  }, 
  "title": "Agent Information", 
  "type": "object"
}

AggregateDataResponse (type) 

{
  "additionalProperties": false, 
  "description": "Final data aggregation response.\nThe results array holds the primary and the related objects\n", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AggregateDataResponse", 
  "module_id": "Search", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array containing the primary and the related object details", 
      "items": {
        "$ref": "AggregateResponse"+
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Data aggregation response", 
  "type": "object"
}

AggregateRequest (type) 

{
  "additionalProperties": false, 
  "description": "Common request parameters for the primary/related types", 
  "extends": {
    "$ref": "IncludedFieldsParameters"+
  }, 
  "id": "AggregateRequest", 
  "module_id": "Search", 
  "properties": {
    "alias": {
      "description": "Alias for the response", 
      "required": false, 
      "title": "Alias", 
      "type": "string"
    }, 
    "filters": {
      "description": "An array of filter conditions", 
      "items": {
        "$ref": "FilterRequest"+
      }, 
      "required": false, 
      "title": "Filter conditions", 
      "type": "array"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource type name", 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "Aggregate request", 
  "type": "object"
}

AggregateResponse (type) 

{
  "additionalProperties": false, 
  "description": "Response for the primary/related types", 
  "id": "AggregateResponse", 
  "module_id": "Search", 
  "properties": {
    "primary": {
      "description": "Requested properties of the primary object", 
      "required": true, 
      "title": "Primary object properties", 
      "type": "object"
    }, 
    "related": {
      "description": "Requested properties of the related objects", 
      "items": {
        "$ref": "RelatedData"+
      }, 
      "required": true, 
      "title": "Related objects properties", 
      "type": "array"
    }
  }, 
  "title": "Aggregate response", 
  "type": "object"
}

Alarm (type) 

{
  "additionalProperties": false, 
  "id": "Alarm", 
  "properties": {
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique identifier for an NSX Alarm", 
      "type": "string"
    }, 
    "severity": {
      "enum": [
        "UNKNOWN", 
        "MINOR", 
        "MAJOR", 
        "CRITICAL"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Severity of an Alarm", 
      "type": "string"
    }, 
    "source_comp": {
      "readonly": true, 
      "required": true, 
      "title": "Alarm source component like nsx-manager, nsx-edge etc", 
      "type": "string"
    }, 
    "source_comp_id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique identifier(like UUID) for the node sending the Alarm", 
      "type": "string"
    }, 
    "source_subcomp": {
      "readonly": true, 
      "required": true, 
      "title": "Alarm source sub component like nsx-mpa etc", 
      "type": "string"
    }, 
    "sources": {
      "items": {
        "$ref": "AlarmSource"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Sources emitting this alarm", 
      "type": "array"
    }, 
    "state": {
      "enum": [
        "UNKNOWN", 
        "ACTIVE", 
        "ACKNOWLEDGED", 
        "RESOLVED"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Alarm state"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": true, 
      "title": "Date and time in UTC of the Alarm"
    }
  }, 
  "title": "Alarm in NSX that needs users' attention", 
  "type": "object"
}

AlarmListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AlarmListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Alarm"+
      }, 
      "required": true, 
      "title": "Alarm results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Alarm collection results", 
  "type": "object"
}

AlarmQueryParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResultQueryParameters"+
  }, 
  "id": "AlarmQueryParameters", 
  "properties": {
    "cursor": {
      "description": "A log cursor points to a specific line number in the alarm list", 
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "integer"
    }, 
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "page_size": {
      "default": 100, 
      "description": "The page size determines the number of alarms to be returned", 
      "maximum": 100, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

AlarmSource (type) 

{
  "id": "AlarmSource", 
  "properties": {
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "Identifier of the Alarm source entity for e.g. Vpn session id, Vpn tunnel id etc.", 
      "type": "string"
    }, 
    "ip_address": {
      "readonly": true, 
      "required": false, 
      "title": "Ip address", 
      "type": "string"
    }, 
    "ip_address_type": {
      "enum": [
        "IPV4", 
        "IPV6"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Ip address type v4, v6 etc."
    }, 
    "local_ip": {
      "readonly": true, 
      "required": false, 
      "title": "VPN session/tunnel etc. local Ip(v4 or v6) address", 
      "type": "string"
    }, 
    "mount": {
      "readonly": true, 
      "required": false, 
      "title": "Filesystem mount name", 
      "type": "string"
    }, 
    "peer_ip": {
      "readonly": true, 
      "required": false, 
      "title": "VPN session/tunnel etc. peer Ip(v4 or v6) address", 
      "type": "string"
    }
  }, 
  "title": "Source of the Alarm", 
  "type": "object"
}

AllAccountsStateInfo (type) 

{
  "additionalProperties": false, 
  "description": "State Information of all accounts like synchronization in progress count.\n", 
  "id": "AllAccountsStateInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "sync_in_progress": {
      "description": "Number of cloud accounts for which inventory synchronization is in progress.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Sync In Progress Count", 
      "type": "integer"
    }
  }, 
  "title": "State Information Of All Accounts", 
  "type": "object"
}

AllAccountsStatistics (type) 

{
  "additional_properties": false, 
  "description": "Stores statistics of all accounts managed by CSM.", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AllAccountsStatistics", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "accounts_count": {
      "description": "Count of the all accounts managed by CSM.", 
      "readonly": true, 
      "required": false, 
      "title": "Accounts Count", 
      "type": "integer"
    }, 
    "accounts_status": {
      "$ref": "AllAccountsStateInfo"+, 
      "description": "Status of all accounts like synchronization in progress count.", 
      "readonly": true, 
      "required": false, 
      "title": "Status Of All Accounts"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Instance statistics accross all accounts managed by CSM.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing all accounts statistics of a particular cloud\nprovider. Legal values are AwsAccount or AzureAccount.\n", 
      "enum": [
        "AwsAccount", 
        "AzureAccount"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }
  }, 
  "title": "All Accounts  Statistics", 
  "type": "object"
}

AllAccountsStatisticsListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores statistics for all accounts managed by CSM.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AllAccountsStatisticsListResult", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "decription": "Array of All Accounts Statistics.", 
      "items": {
        "$ref": "AllAccountsStatistics"+
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "All Accounts Statistics List Result", 
  "type": "object"
}

AllAccountsStatisticsRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of optional filter paramters to list all accounts statistics.", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AllAccountsStatisticsRequestParameters", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "cloud_type": {
      "description": "Optional identifier for cloud provider based on which all accounts\nstatistics are to be filtered. Legal values are AWS or AZURE.\n", 
      "enum": [
        "AWS", 
        "AZURE"
      ], 
      "required": false, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing all accounts statistics of a particular cloud\nprovider. Legal values are AwsAccount or AzureAccount.\n", 
      "enum": [
        "AwsAccount", 
        "AzureAccount"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "All Accounts Statistics Request Parameters", 
  "type": "object"
}

AllAwsAccountsStatistics (type) 

{
  "additional_properties": false, 
  "description": "Stores statistics of all AWS accounts.", 
  "extends": {
    "$ref": "AllAccountsStatistics"+
  }, 
  "id": "AllAwsAccountsStatistics", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "accounts_count": {
      "description": "Count of the all accounts managed by CSM.", 
      "readonly": true, 
      "required": false, 
      "title": "Accounts Count", 
      "type": "integer"
    }, 
    "accounts_status": {
      "$ref": "AllAccountsStateInfo"+, 
      "description": "Status of all accounts like synchronization in progress count.", 
      "readonly": true, 
      "required": false, 
      "title": "Status Of All Accounts"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Instance statistics accross all accounts managed by CSM.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics"
    }, 
    "regions_count": {
      "description": "Count of the regions accessible.", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Regions Count", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing all accounts statistics of a particular cloud\nprovider. Legal values are AwsAccount or AzureAccount.\n", 
      "enum": [
        "AwsAccount", 
        "AzureAccount"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "vpc_stats": {
      "$ref": "VpcStats"+, 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }
  }, 
  "title": "All AWS Accounts  Statistics", 
  "type": "object"
}

AllAzureAccountsStatistics (type) 

{
  "additional_properties": false, 
  "description": "Stores statistics of all Azure accounts.", 
  "extends": {
    "$ref": "AllAccountsStatistics"+
  }, 
  "id": "AllAzureAccountsStatistics", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "accounts_count": {
      "description": "Count of the all accounts managed by CSM.", 
      "readonly": true, 
      "required": false, 
      "title": "Accounts Count", 
      "type": "integer"
    }, 
    "accounts_status": {
      "$ref": "AllAccountsStateInfo"+, 
      "description": "Status of all accounts like synchronization in progress count.", 
      "readonly": true, 
      "required": false, 
      "title": "Status Of All Accounts"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Instance statistics accross all accounts managed by CSM.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics"
    }, 
    "regions_count": {
      "description": "Count of the regions accessible.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Regions Count", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing all accounts statistics of a particular cloud\nprovider. Legal values are AwsAccount or AzureAccount.\n", 
      "enum": [
        "AwsAccount", 
        "AzureAccount"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "vnet_stats": {
      "$ref": "VnetStats"+, 
      "description": "Virtual network statistics accross all Azure accounts managed by CSM.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Network Statistics"
    }
  }, 
  "title": "All Azure Accounts Statistics", 
  "type": "object"
}

AllClusterGroupStatus (type) 

{
  "additionalProperties": false, 
  "description": "A list of the statuses of all the groups in the cluster.", 
  "id": "AllClusterGroupStatus", 
  "module_id": "Cluster", 
  "properties": {
    "cluster_id": {
      "readonly": true, 
      "title": "UUID of the cluster", 
      "type": "string"
    }, 
    "groups": {
      "items": {
        "$ref": "ClusterGroupStatus"+
      }, 
      "readonly": true, 
      "title": "Array of groups and their statuses", 
      "type": "array"
    }
  }, 
  "title": "Status of all the cluster groups", 
  "type": "object"
}

AllocationIpAddress (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AllocationIpAddress", 
  "module_id": "Ipam", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allocation_id": {
      "$ref": "IPAddress"+, 
      "readonly": true, 
      "title": "Address that is allocated from pool"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AllocationIpAddressListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AllocationIpAddressListResult", 
  "module_id": "Ipam", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AllocationIpAddress"+
      }, 
      "required": true, 
      "title": "Pool allocation list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AllocationPoolType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "LoadBalancerAllocationPool"
  ], 
  "id": "AllocationPoolType", 
  "module_id": "LogicalRouter", 
  "title": "Types of logical router allocation pool based on services", 
  "type": "string"
}

ApiError (type) 

{
  "extends": {
    "$ref": "RelatedApiError"+
  }, 
  "id": "ApiError", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "title": "Further details about the error", 
      "type": "string"
    }, 
    "error_code": {
      "title": "A numeric error code", 
      "type": "integer"
    }, 
    "error_data": {
      "title": "Additional data about the error", 
      "type": "object"
    }, 
    "error_message": {
      "title": "A description of the error", 
      "type": "string"
    }, 
    "module_name": {
      "title": "The module name where the error occurred", 
      "type": "string"
    }, 
    "related_errors": {
      "items": {
        "$ref": "RelatedApiError"+
      }, 
      "title": "Other errors related to this error", 
      "type": "array"
    }
  }, 
  "title": "Detailed information about an API Error", 
  "type": "object"
}

AppDiscoveryAppProfileResultSummary (type) 

{
  "description": "Contains the application discovery result summary of the App Profile\n", 
  "id": "AppDiscoveryAppProfileResultSummary", 
  "module_id": "AppDiscovery", 
  "properties": {
    "app_profile_id": {
      "required": false, 
      "title": "ID of the App Profile", 
      "type": "string"
    }, 
    "display_name": {
      "required": false, 
      "title": "Name of the App Profile", 
      "type": "string"
    }, 
    "installed_apps_count": {
      "required": false, 
      "title": "Number of apps installed that belongs to this App Profile", 
      "type": "integer"
    }
  }, 
  "title": "Application discovery result summary of an App Profile", 
  "type": "object"
}

AppDiscoverySession (type) 

{
  "description": "Contains the details of an application discovery session\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AppDiscoverySession", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "end_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "End time of the session expressed in milliseconds since epoch"
    }, 
    "failed_reason": {
      "readonly": true, 
      "required": false, 
      "title": "The reason for the session status failure.", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "reclassification": {
      "description": "Some App Profiles that were part of the discovery session could be modified or deleted |\nafter the session has been completed. NOT_REQUIRED status denotes that there were no such modifications. |\nREQUIRED status denotes some App Profiles that were part of the session has been modified/deleted and some |\nand some applications might not have been classfifed correctly. Use /session/<session-id>/reclassify API to|\nre-classfy the applications discovered based on app profiles.\n", 
      "enum": [
        "NOT_REQUIRED", 
        "REQUIRED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The reclassification status of the discovery session", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "start_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "Start time of the session expressed in milliseconds since epoch"
    }, 
    "status": {
      "enum": [
        "FAILED", 
        "RUNNING", 
        "FINISHED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The status of the session", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Contains the details of an application discovery session", 
  "type": "object"
}

AppDiscoverySessionResultSummary (type) 

{
  "description": "Contains the summary of the results of an application discovery session\n", 
  "extends": {
    "$ref": "AppDiscoverySession"+
  }, 
  "id": "AppDiscoverySessionResultSummary", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "app_profile_summary_list": {
      "items": {
        "$ref": "AppDiscoveryAppProfileResultSummary"+
      }, 
      "required": false, 
      "title": "List of App Profiles summary discovered in this session", 
      "type": "array"
    }, 
    "app_profiles": {
      "items": {
        "$ref": "AppProfileMetaInfo"+
      }, 
      "required": false, 
      "title": "List of app profiles targeted to be classified for this session", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "end_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "End time of the session expressed in milliseconds since epoch"
    }, 
    "failed_reason": {
      "readonly": true, 
      "required": false, 
      "title": "The reason for the session status failure.", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ns_groups": {
      "items": {
        "$ref": "NSGroupMetaInfo"+
      }, 
      "required": false, 
      "title": "List of NSGroups provided for discovery for this session", 
      "type": "array"
    }, 
    "reclassification": {
      "description": "Some App Profiles that were part of the discovery session could be modified or deleted |\nafter the session has been completed. NOT_REQUIRED status denotes that there were no such modifications. |\nREQUIRED status denotes some App Profiles that were part of the session has been modified/deleted and some |\nand some applications might not have been classfifed correctly. Use /session/<session-id>/reclassify API to|\nre-classfy the applications discovered based on app profiles.\n", 
      "enum": [
        "NOT_REQUIRED", 
        "REQUIRED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The reclassification status of the discovery session", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "start_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "Start time of the session expressed in milliseconds since epoch"
    }, 
    "status": {
      "enum": [
        "FAILED", 
        "RUNNING", 
        "FINISHED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The status of the session", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Contains the summary of the results of an application discovery session", 
  "type": "object"
}

AppDiscoverySessionsListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AppDiscoverySessionsListResult", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AppDiscoverySession"+
      }, 
      "required": true, 
      "title": "AppProfile Sessions results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Application discovery sessions list", 
  "type": "object"
}

AppDiscoverySessionsParameters (type) 

{
  "description": "Parameters to query application discovery sessions with.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AppDiscoverySessionsParameters", 
  "module_id": "AppDiscovery", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "group_id": {
      "required": false, 
      "title": "NSGroup id, helps user query sessions related to one nsgroup", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "STARTING", 
        "FAILED", 
        "RUNNING", 
        "FINISHED"
      ], 
      "required": false, 
      "title": "Session Status, e.g. get all running sessions", 
      "type": "string"
    }
  }, 
  "title": "Parameters to query session with, such as nsgroup id", 
  "type": "object"
}

AppDiscoveryVmInfo (type) 

{
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AppDiscoveryVmInfo", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "os_properties": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "OS properties of the VM", 
      "type": "array"
    }, 
    "os_type": {
      "enum": [
        "INVALID", 
        "WINDOWS", 
        "LINUX"
      ], 
      "required": false, 
      "title": "OS type of the VM", 
      "type": "string"
    }, 
    "vm_external_id": {
      "title": "External Id of the VM", 
      "type": "string"
    }, 
    "vm_name": {
      "required": false, 
      "title": "Name of the VM", 
      "type": "string"
    }
  }, 
  "title": "AppDiscoveryVmInfo details", 
  "type": "object"
}

AppDiscoveryVmInfoListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AppDiscoveryVmInfoListResult", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AppDiscoveryVmInfo"+
      }, 
      "required": true, 
      "title": "list of AppDiscoveryVmInfos", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AppDiscoveryVmInfo list", 
  "type": "object"
}

AppInfo (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AppInfo", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "manufacturer": {
      "required": false, 
      "title": "Manufacturer of the app", 
      "type": "string"
    }, 
    "name": {
      "required": false, 
      "title": "Name of the app", 
      "type": "string"
    }, 
    "os_type": {
      "enum": [
        "INVALID", 
        "WINDOWS", 
        "LINUX"
      ], 
      "required": false, 
      "title": "OS type of VM the App belongs to", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "version": {
      "required": false, 
      "title": "Version of the app", 
      "type": "string"
    }, 
    "vm_ids": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Ids of the VMs in which this app is installed", 
      "type": "array"
    }
  }, 
  "title": "AppInfo details", 
  "type": "object"
}

AppInfoHostVmCsvRecord (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "AppInfoHostVmCsvRecord", 
  "module_id": "AppDiscovery", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "title": "Name of the app", 
      "type": "string"
    }, 
    "host_vms": {
      "readonly": true, 
      "title": "vm ids that this application belongs to", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "title": "Id of the app", 
      "type": "string"
    }, 
    "manufacturer": {
      "readonly": true, 
      "title": "Manufacturer of the app", 
      "type": "string"
    }, 
    "os_type": {
      "enum": [
        "INVALID", 
        "WINDOWS", 
        "LINUX"
      ], 
      "required": false, 
      "title": "OS type of the VM", 
      "type": "string"
    }, 
    "version": {
      "readonly": true, 
      "title": "Version of the app", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AppInfoHostVmListInCsvFormat (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "AppInfoHostVmListInCsvFormat", 
  "module_id": "AppDiscovery", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "results": {
      "items": {
        "$ref": "AppInfoHostVmCsvRecord"+
      }, 
      "required": false, 
      "title": "List of appplications discovered during an application discovery session", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AppInfoListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AppInfoListResult", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AppInfo"+
      }, 
      "required": true, 
      "title": "Application details corresponding to the App Profile", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AppInfo Sessions list results", 
  "type": "object"
}

AppProfile (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AppProfile", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "app_profile_category": {
      "required": false, 
      "title": "Category of the app profile, value could be any string that describes the profile", 
      "type": "string"
    }, 
    "app_profile_criteria": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Criteria of the app profile, value could be any string or \"*\"\n(match any string)\n", 
      "type": "array"
    }, 
    "default_app_profile": {
      "required": false, 
      "title": "True if this App Profile is a default profile (automatically created by the system)", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "AppProfile details", 
  "type": "object"
}

AppProfileListRequestParameters (type) 

{
  "description": "Parameters to query app profiles with.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AppProfileListRequestParameters", 
  "module_id": "AppDiscovery", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Parameters to query app profiles with", 
  "type": "object"
}

AppProfileListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AppProfileListResult", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AppProfile"+
      }, 
      "required": true, 
      "title": "AppProfile IDs", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "App Profile ID list", 
  "type": "object"
}

AppProfileMemberAppsCsvRecord (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "AppProfileMemberAppsCsvRecord", 
  "module_id": "AppDiscovery", 
  "properties": {
    "app_profile_category": {
      "readonly": true, 
      "title": "Category of the app profile, value could be any string that describes the profile", 
      "type": "string"
    }, 
    "app_profile_criteria": {
      "readonly": true, 
      "title": "Criteria of the app profile, value could be any string or \"*\" (match any string)", 
      "type": "string"
    }, 
    "description": {
      "readonly": true, 
      "title": "Description of the app profile", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": true, 
      "title": "Name of the app profile", 
      "type": "string"
    }, 
    "member_apps": {
      "readonly": true, 
      "title": "Applications that are member of this app profile", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AppProfileMemberAppsListInCsvFormat (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "AppProfileMemberAppsListInCsvFormat", 
  "module_id": "AppDiscovery", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "results": {
      "items": {
        "$ref": "AppProfileMemberAppsCsvRecord"+
      }, 
      "required": false, 
      "title": "List of app profiles for an application discovery session", 
      "type": "array"
    }
  }, 
  "type": "object"
}

AppProfileMetaInfo (type) 

{
  "description": "Contains the metadata of an App Profile\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AppProfileMetaInfo", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "app_profile_category": {
      "required": false, 
      "title": "Categories of the app profile", 
      "type": "string"
    }, 
    "app_profile_id": {
      "required": false, 
      "title": "ID of the App Profile", 
      "type": "string"
    }, 
    "app_profile_name": {
      "required": false, 
      "title": "Name of the App Profile", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Metadata about App Profile", 
  "type": "object"
}

ApplianceManagementSuppressRedirectQueryParameter (type) 

{
  "additionalProperties": false, 
  "id": "ApplianceManagementSuppressRedirectQueryParameter", 
  "properties": {
    "suppress_redirect": {
      "default": false, 
      "description": "Do not return a redirect HTTP status.", 
      "title": "Suppress redirect status if applicable", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ApplianceManagementTaskListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ApplianceManagementTaskListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ApplianceManagementTaskProperties"+
      }, 
      "required": true, 
      "title": "Task property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Appliance management task query results", 
  "type": "object"
}

ApplianceManagementTaskProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "ApplianceManagementTaskProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "async_response_available": {
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "title": "Details about the task if known", 
      "type": "object"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "id": {
      "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", 
      "readonly": true, 
      "title": "Identifier for this task", 
      "type": "string"
    }, 
    "message": {
      "readonly": true, 
      "title": "A message describing the disposition of the task", 
      "type": "string"
    }, 
    "progress": {
      "maximum": 100, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Task progress if known, from 0 to 100", 
      "type": "integer"
    }, 
    "request_method": {
      "readonly": true, 
      "title": "HTTP request method", 
      "type": "string"
    }, 
    "request_uri": {
      "readonly": true, 
      "title": "URI of the method invocation that spawned this task", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "The start time of the task in epoch milliseconds"
    }, 
    "status": {
      "$ref": "ApplianceManagementTaskStatus"+, 
      "readonly": true, 
      "title": "Current status of the task"
    }, 
    "user": {
      "readonly": true, 
      "title": "Name of the user who created this task", 
      "type": "string"
    }
  }, 
  "title": "Appliance management task properties", 
  "type": "object"
}

ApplianceManagementTaskQueryParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResultQueryParameters"+
  }, 
  "id": "ApplianceManagementTaskQueryParameters", 
  "properties": {
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "request_method": {
      "description": "Comma-separated request methods to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request method(s) to include in query result", 
      "type": "string"
    }, 
    "request_path": {
      "description": "Comma-separated request paths to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request URI path(s) to include in query result", 
      "type": "string"
    }, 
    "request_uri": {
      "description": "Comma-separated request URIs to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Request URI(s) to include in query result", 
      "type": "string"
    }, 
    "status": {
      "description": "Comma-separated status values to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Status(es) to include in query result", 
      "type": "string"
    }, 
    "user": {
      "description": "Comma-separated user names to include in query result", 
      "pattern": "^(=|!=|~|!~)?.+$", 
      "title": "Names of users to include in query result", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ApplianceManagementTaskStatus (type) 

{
  "enum": [
    "running", 
    "error", 
    "success", 
    "canceling", 
    "canceled", 
    "killed"
  ], 
  "id": "ApplianceManagementTaskStatus", 
  "title": "Current status of the appliance management task", 
  "type": "string"
}

ApplicationProfileType (type) 

{
  "additionalProperties": false, 
  "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.\n", 
  "enum": [
    "LbHttpProfile", 
    "LbFastTcpProfile", 
    "LbFastUdpProfile"
  ], 
  "id": "ApplicationProfileType", 
  "module_id": "LoadBalancer", 
  "title": "application profile type", 
  "type": "string"
}

AppliedTos (type) 

{
  "description": "Entity lists where the profile will be enabled on.\n", 
  "id": "AppliedTos", 
  "module_id": "UpmCommon", 
  "properties": {
    "logical_ports": {
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Logical Port List", 
      "type": "array"
    }, 
    "logical_switches": {
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Logical Switch List", 
      "type": "array"
    }, 
    "nsgroups": {
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "nsx_feature": "UnifiedProfileManagementSupportNSGroup", 
      "readonly": false, 
      "required": false, 
      "title": "NSGroup List", 
      "type": "array"
    }
  }, 
  "title": "Entities Applied to Profile", 
  "type": "object"
}

AssignedByDhcp (type) 

{
  "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.", 
  "extends": {
    "$ref": "IpAssignmentSpec"+
  }, 
  "id": "AssignedByDhcp", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AssignedByDhcp"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "StaticIpPoolSpec", 
        "StaticIpListSpec", 
        "AssignedByDhcp", 
        "StaticIpMacListSpec"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "DHCP based IP assignment.", 
  "type": "object"
}

AssociationListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AssociationListRequestParameters", 
  "module_id": "Association", 
  "properties": {
    "associated_resource_type": {
      "$ref": "AssociationTargetType"+, 
      "required": true, 
      "title": "Type of the associated resources"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "fetch_ancestors": {
      "default": false, 
      "description": "If set to true, will fetch direct as well as\nindirect(considering containment as well as nesting)\nassociated objects for the given source Id.\n", 
      "required": false, 
      "title": "Fetch complete list of associated resources considering\ncontainment and nesting\n", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_id": {
      "required": true, 
      "title": "The resource for which associated resources are to be fetched", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "AssociationSourceType"+, 
      "required": true, 
      "title": "Type of the resource for which associated resources are to be fetched"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Association list request parameters", 
  "type": "object"
}

AssociationListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AssociationListResult", 
  "module_id": "Association", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "required": true, 
      "title": "Paged Collection of ResourceReference", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AssociationSourceType (type) 

{
  "enum": [
    "NSGroup", 
    "IPSet", 
    "MACSet", 
    "LogicalSwitch", 
    "LogicalPort", 
    "VirtualMachine", 
    "DirectoryGroup"
  ], 
  "id": "AssociationSourceType", 
  "module_id": "Association", 
  "title": "Resource type valid for use as source in association API", 
  "type": "string"
}

AssociationTargetType (type) 

{
  "enum": [
    "NSGroup"
  ], 
  "id": "AssociationTargetType", 
  "module_id": "Association", 
  "title": "Resource type valid for use as target in association API", 
  "type": "string"
}

AttachmentContext (type) 

{
  "abstract": true, 
  "id": "AttachmentContext", 
  "module_id": "LogicalPort", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "allocate_addresses": {
      "enum": [
        "IpPool", 
        "MacPool", 
        "Both", 
        "None"
      ], 
      "required": false, 
      "title": "A flag to indicate whether to allocate addresses from allocation\n    pools bound to the parent logical switch.\n", 
      "type": "string"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'VifAttachmentContext' or 'L2VpnAttachmentContext'\n", 
      "required": true, 
      "title": "Used to identify which concrete class it is", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AttachmentType (type) 

{
  "enum": [
    "VIF", 
    "LOGICALROUTER", 
    "BRIDGEENDPOINT", 
    "DHCP_SERVICE", 
    "METADATA_PROXY", 
    "L2VPN_SESSION"
  ], 
  "id": "AttachmentType", 
  "module_id": "LogicalPort", 
  "title": "Type of attachment for logical port.", 
  "type": "string"
}

AttachmentTypeQueryString (type) 

{
  "enum": [
    "VIF", 
    "LOGICALROUTER", 
    "BRIDGEENDPOINT", 
    "DHCP_SERVICE", 
    "METADATA_PROXY", 
    "L2VPN_SESSION", 
    "NONE"
  ], 
  "id": "AttachmentTypeQueryString", 
  "module_id": "LogicalPort", 
  "title": "Type of attachment for logical port; for query only.", 
  "type": "string"
}

Attribute (type) 

{
  "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.", 
  "id": "Attribute", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "attribute_type": {
      "description": "Attribute Type can be of any of the allowed enum type.", 
      "enum": [
        "IP_ADDRESS", 
        "PORT", 
        "PASSWORD", 
        "STRING", 
        "LONG"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Attributetype.", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Attribute display name string value.", 
      "readonly": false, 
      "required": false, 
      "title": "Display name", 
      "type": "string"
    }, 
    "key": {
      "description": "Attribute key string value.", 
      "readonly": false, 
      "required": false, 
      "title": "key", 
      "type": "string"
    }, 
    "value": {
      "description": "Attribute value string value.", 
      "readonly": false, 
      "required": false, 
      "title": "value", 
      "type": "string"
    }
  }, 
  "title": "Attributes", 
  "type": "object"
}

AuditLog (type) 

{
  "additionalProperties": false, 
  "id": "AuditLog", 
  "properties": {
    "appname": {
      "required": true, 
      "title": "Application name field of the log", 
      "type": "string"
    }, 
    "facility": {
      "required": true, 
      "title": "Facility field of the log", 
      "type": "integer"
    }, 
    "full_log": {
      "required": true, 
      "title": "Full log with both header and message", 
      "type": "string"
    }, 
    "hostname": {
      "required": true, 
      "title": "Hostname field of the log", 
      "type": "string"
    }, 
    "message": {
      "required": true, 
      "title": "Message field of the log", 
      "type": "string"
    }, 
    "msgid": {
      "required": true, 
      "title": "Message ID field of the log", 
      "type": "string"
    }, 
    "priority": {
      "required": true, 
      "title": "Priority field of the log", 
      "type": "integer"
    }, 
    "procid": {
      "required": true, 
      "title": "Process ID field of the log", 
      "type": "integer"
    }, 
    "struct_data": {
      "$ref": "StructuredData"+, 
      "required": true, 
      "title": "Structured data field of the log"
    }, 
    "timestamp": {
      "required": true, 
      "title": "Date and time in UTC of the log", 
      "type": "string"
    }
  }, 
  "title": "Audit log in RFC5424 format", 
  "type": "object"
}

AuditLogListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AuditLogListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_full_sync_timestamp": {
      "required": true, 
      "title": "Timestamp of the last full audit log collection", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AuditLog"+
      }, 
      "required": true, 
      "title": "Audit log results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Audit log collection results", 
  "type": "object"
}

AuditLogQueryParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResultQueryParameters"+
  }, 
  "id": "AuditLogQueryParameters", 
  "properties": {
    "cursor": {
      "description": "A log cursor points to a specific line number in the master audit log", 
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "integer"
    }, 
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }, 
    "page_size": {
      "default": 100, 
      "description": "The page size determines the number of logs to be returned", 
      "maximum": 100, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

AuditLogRequest (type) 

{
  "additionalProperties": false, 
  "id": "AuditLogRequest", 
  "properties": {
    "log_age_limit": {
      "minimum": 0, 
      "title": "Include logs with timstamps not past the age limit in days", 
      "type": "integer"
    }, 
    "log_filter": {
      "required": false, 
      "title": "Audit logs should meet the filter condition", 
      "type": "string"
    }, 
    "log_filter_type": {
      "default": "TEXT", 
      "enum": [
        "TEXT", 
        "REGEX"
      ], 
      "title": "Type of log filter", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AuthenticationPolicyProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AuthenticationPolicyProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "api_failed_auth_lockout_period": {
      "default": 900, 
      "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.", 
      "minimum": 0, 
      "title": "Lockout period in seconds", 
      "type": "integer"
    }, 
    "api_failed_auth_reset_period": {
      "default": 900, 
      "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.", 
      "minimum": 0, 
      "title": "Period, in seconds, for authentication failures to trigger lockout", 
      "type": "integer"
    }, 
    "api_max_auth_failures": {
      "default": 5, 
      "description": "Only applies to NSX Manager nodes. Ignored on other node types.", 
      "minimum": 0, 
      "title": "Number of authentication failures that trigger API lockout", 
      "type": "integer"
    }, 
    "cli_failed_auth_lockout_period": {
      "default": 900, 
      "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.", 
      "minimum": 0, 
      "title": "Lockout period in seconds", 
      "type": "integer"
    }, 
    "cli_max_auth_failures": {
      "default": 5, 
      "minimum": 0, 
      "title": "Number of authentication failures that trigger CLI lockout", 
      "type": "integer"
    }, 
    "minimum_password_length": {
      "default": 8, 
      "minimum": 8, 
      "title": "Minimum number of characters required in account passwords", 
      "type": "integer"
    }
  }, 
  "title": "Configuration of authentication policies for the NSX node", 
  "type": "object"
}

AuthenticationScheme (type) 

{
  "additionalProperties": {}, 
  "id": "AuthenticationScheme", 
  "properties": {
    "scheme_name": {
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsAccount (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CloudAccount"+
  }, 
  "id": "AwsAccount", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_key": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use the field credentials.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Access key of cloud account", 
      "type": "string"
    }, 
    "auth_mechanism_iam": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use the field auth_method.", 
      "readonly": false, 
      "required": false, 
      "title": "Is the AWS authorization mechanism based on Identity and Access\nManagement(IAM) service?\n", 
      "type": "boolean"
    }, 
    "auth_method": {
      "description": "This property conveys the authorization method to use. Appropriate\ncredentials/parameters will be expected based on this method selection.\n", 
      "enum": [
        "CREDENTIALS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "AWS account authorization method", 
      "type": "string"
    }, 
    "auth_users": {
      "description": "List of authorized users.", 
      "items": {
        "$ref": "CloudUserInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Authrized Users", 
      "type": "array"
    }, 
    "cloud_tags_enabled": {
      "default": true, 
      "description": "Boolean flag to enable or disable cloud tags discovery. The discovered\ncloud tags can be used to define security group membership.\n", 
      "hidden": true, 
      "readonly": false, 
      "required": false, 
      "title": "Boolean flag to enable or disable cloud tags discovery", 
      "type": "boolean"
    }, 
    "cloud_type": {
      "decription": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "credentials": {
      "$ref": "AwsCredentials"+, 
      "description": "Credentials of AWS Account.", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Credentials"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use the field credentials.", 
      "readonly": false, 
      "required": false, 
      "title": "External id for the IAM role csm needs to assume", 
      "type": "string"
    }, 
    "gateway_role_name": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use the field credentials.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Gateway Role Name", 
      "type": "string"
    }, 
    "has_managed_vpc": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use vpc_stats to get the number of\nmanaged VPCs.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Has a managed VPC?", 
      "type": "boolean"
    }, 
    "iam_role_arn": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use the field credentials.", 
      "readonly": false, 
      "required": false, 
      "title": "Amazon Resource Name for IAM role CSM needs to assume", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Stores statistics of the number of managed, unmanaged and error virtual\nmachines.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "regions_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of the regions accessible", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "secret_key": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use the field credentials.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Secret key of cloud account", 
      "type": "string"
    }, 
    "status": {
      "$ref": "AwsAccountStatus"+, 
      "readonly": true, 
      "required": false, 
      "title": "Status of the account"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the cloud account.", 
      "readonly": true, 
      "required": false, 
      "title": "Tenant ID", 
      "type": "string"
    }, 
    "vpc_stats": {
      "$ref": "VpcStats"+, 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }
  }, 
  "title": "AWS account", 
  "type": "object"
}

AwsAccountStatus (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CloudAccountStatus"+
  }, 
  "id": "AwsAccountStatus", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "credentials_status": {
      "description": "Status of the cloud account credentials synced at the auto interval.\n", 
      "enum": [
        "VALID", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Credentials Status", 
      "type": "string"
    }, 
    "error_message": {
      "description": "Error encountered while syncing AWS inventory such as read timeout.", 
      "readonly": true, 
      "required": false, 
      "title": "Error encountered while syncing AWS inventory", 
      "type": "string"
    }, 
    "inventory_sync_status": {
      "description": "Status of inventory synchronization process.", 
      "enum": [
        "SYNCED", 
        "IN_PROGRESS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory Synchronization Status", 
      "type": "string"
    }, 
    "inventory_sync_step": {
      "description": "Step of the inventory synchronization process", 
      "enum": [
        "SYNCING_AWS_REGIONS", 
        "SYNCING_AWS_VPCS", 
        "SYNCING_AWS_AZS", 
        "SYNCING_VMS", 
        "SYNCING_NSX_DATA", 
        "SYNCING_AWS_GATEWAYS", 
        "SYNCING_MANAGED_INSTANCES", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "title": "Inventory sync step", 
      "type": "string"
    }
  }, 
  "title": "AWS account status", 
  "type": "object"
}

AwsAccountsListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These parameters will be used to filter the list of accounts.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsAccountsListRequestParameters", 
  "module_id": "CloudAccounts", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which accounts statistics will be\naggregated. Using this request parameter will return\nonly all_accounts_vpc_stats and all_accounts_instance_stats properties.\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsAccountsListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsAccountsListResult", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "all_accounts_instance_stats": {
      "$ref": "InstanceStats"+, 
      "deprecated": true, 
      "description": "This field is DEPRECATED. To obtain statistics about instances, use the\nGET /csm/accounts/statistics API.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "all_accounts_vpc_stats": {
      "$ref": "VpcStats"+, 
      "deprecated": true, 
      "description": "This field is DEPRECATED. To obtain statistics about VPCs, use the\nGET /csm/accounts/statistics API.\n", 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsAccount"+
      }, 
      "required": true, 
      "title": "AWS accounts list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cloud accounts list", 
  "type": "object"
}

AwsAvailabilityZoneInfo (type) 

{
  "additionalProperties": false, 
  "id": "AwsAvailabilityZoneInfo", 
  "module_id": "AwsRegionInformation", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Display name of the availability zone", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the availability zone", 
      "type": "string"
    }
  }, 
  "title": "Availability Zone information", 
  "type": "object"
}

AwsCredentials (type) 

{
  "additional_properties": false, 
  "description": "Stores information about AWS account credentials.", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AwsCredentials", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "access_key": {
      "description": "Access key of the AWS account.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Access Key", 
      "type": "string"
    }, 
    "gateway_role": {
      "description": "Name of the IAM service role that should be attached to the Cloud\nGateways deployed in the AWS account. Based on the permissions in the\nrole, the gateways will have access to resources in the AWS account.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Gateway Role Name", 
      "type": "string"
    }, 
    "secret_key": {
      "description": "Secret key of the AWS account.", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Secret Key", 
      "type": "string"
    }
  }, 
  "title": "AWS Account Credentials", 
  "type": "object"
}

AwsGatewayAmiInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AwsGatewayAmiInfo", 
  "module_id": "AwsGatewayAmiInformation", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "ami_id": {
      "description": "The ID of the Amazon Machine Image", 
      "required": true, 
      "title": "AMI id", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "region_id": {
      "required": true, 
      "title": "Name of the Aws Region in which ami is present", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Aws Gateway Ami Information", 
  "type": "object"
}

AwsGatewayAmisListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of AWS Gateway AMIs.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsGatewayAmisListRequestParameters", 
  "module_id": "AwsGatewayAmiInformation", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which list of AWS Gateway AMIs\nwill be obtained\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsGatewayAmisListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsGatewayAmisListResult", 
  "module_id": "AwsGatewayAmiInformation", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsGatewayAmiInfo"+
      }, 
      "required": false, 
      "title": "Aws Gateway amis list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Aws Gateway amis", 
  "type": "object"
}

AwsGatewayConfig (type) 

{
  "additionalProperties": false, 
  "description": "Stores AWS gateway configuration like ami_id, key_pair_name and\ngateway_ha_configuration.\n", 
  "extends": {
    "$ref": "GatewayConfig"+
  }, 
  "id": "AwsGatewayConfig", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "ami_id": {
      "description": "The ID of the Amazon Machine Image on which this gateway resides\n", 
      "required": false, 
      "title": "AMI id", 
      "type": "string"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway\nundeployed.\n", 
      "required": false, 
      "title": "Id of cloud security group", 
      "type": "string"
    }, 
    "default_quarantine_policy_enabled": {
      "required": false, 
      "title": "Flag to identify if default quarantine policy is enabled", 
      "type": "boolean"
    }, 
    "dns_settings": {
      "$ref": "DnsSettings"+, 
      "description": "Settings related to Cloud gateway DNS configuration. This determines\nDNS configuration based on dns_mode.\n", 
      "title": "DNS settings"
    }, 
    "gateway_ha_configuration": {
      "items": {
        "$ref": "AwsGatewayHaConfig"+
      }, 
      "required": false, 
      "title": "Aws Gateway HA configuration", 
      "type": "array"
    }, 
    "is_ha_enabled": {
      "required": false, 
      "title": "Flag to identify if HA is enabled", 
      "type": "boolean"
    }, 
    "key_pair_name": {
      "required": false, 
      "title": "The key pair name required to authenticate into any instance", 
      "type": "string"
    }, 
    "nsx_manager_connection": {
      "description": "Determines if connection to NSX Manager is via public IP or private IP\n", 
      "enum": [
        "PUBLIC_IP", 
        "PRIVATE_IP"
      ], 
      "required": false, 
      "title": "NSX Manager connection", 
      "type": "string"
    }, 
    "proxy_server_profile": {
      "description": "Id of the proxy server profile, corresponding proxy settings\nwill be applied while deploying the gateway.\n", 
      "required": false, 
      "title": "Id of the proxy server profile", 
      "type": "string"
    }, 
    "vpn_service_enabled": {
      "default": true, 
      "description": "Flag that will enable or disable inter-operation between NSX and\nnon-NSX services via VPN.\n", 
      "required": false, 
      "title": "Flag to enable or disable inter-operation with services via VPN", 
      "type": "boolean"
    }
  }, 
  "title": "AWS gateway configuration", 
  "type": "object"
}

AwsGatewayDeployConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AwsGatewayDeployConfig", 
  "module_id": "AwsGatewayManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "account_id": {
      "required": true, 
      "title": "ID of the Aws account", 
      "type": "string"
    }, 
    "configuration": {
      "$ref": "AwsGatewayConfig"+, 
      "readonly": true, 
      "required": false, 
      "title": "Configuration of this gateway"
    }, 
    "vpc_id": {
      "required": true, 
      "title": "ID of the vpc", 
      "type": "string"
    }
  }, 
  "title": "Aws gateway deployment configuration", 
  "type": "object"
}

AwsGatewayHaConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AwsGatewayHaConfig", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "availability_zone": {
      "required": true, 
      "title": "Availability Zone", 
      "type": "string"
    }, 
    "downlink_subnet": {
      "required": true, 
      "title": "Downlink subnet", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": true, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "management_subnet": {
      "required": true, 
      "title": "Management subnet", 
      "type": "string"
    }, 
    "public_ip_settings": {
      "$ref": "GatewayPublicIp"+, 
      "description": "Stores settings related to AWS gateway Public IP configuration.\nThe public_ip will be attached to management interface of the\ngateway, based on the value of ip_allocation_mode.\n", 
      "required": false, 
      "title": "Public IP settings for management interface"
    }, 
    "uplink_public_ip_settings": {
      "$ref": "GatewayPublicIp"+, 
      "description": "Stores settings related to AWS gateway Public IP configuration.\nThe public_ip will be attached to uplink interface of\nthe primary gateway, based on the value of ip_allocation_mode.\n", 
      "required": false, 
      "title": "Public IP settings for uplink interface"
    }, 
    "uplink_subnet": {
      "required": true, 
      "title": "Uplink subnet", 
      "type": "string"
    }
  }, 
  "title": "AWS subnet configuration to deploy gateways", 
  "type": "object"
}

AwsGatewayInfo (type) 

{
  "additionalProperties": false, 
  "description": "Stores AWS gateway information like configuration and status.", 
  "id": "AwsGatewayInfo", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "configuration": {
      "$ref": "AwsGatewayConfig"+, 
      "description": "Configuration of AWS gateway", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Configuration"
    }, 
    "csm_ip_address": {
      "description": "Cloud service manager IP address used to communicate\nwith the AWS Vpc gateways.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Cloud service manager IP address", 
      "type": "string"
    }, 
    "gateway_status": {
      "$ref": "AwsGatewayStatus"+, 
      "description": "Array of gateway statuses", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status"
    }
  }, 
  "title": "AWS Gateway Information", 
  "type": "object"
}

AwsGatewayInstanceStatus (type) 

{
  "description": "Stores information about AWS gateway instance status", 
  "extends": {
    "$ref": "GatewayInstanceStatus"+
  }, 
  "id": "AwsGatewayInstanceStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "deployment_step": {
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "COPYING_IMAGE", 
        "CREATING_SECURITY_GROUPS", 
        "LAUNCHING_GATEWAY", 
        "CREATING_NETWORK_INTERFACES", 
        "ATTACHING_NETWORK_INTERFACES", 
        "ATTACHING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "CREATING_LOGICAL_NETWORK_CONSTRUCTS", 
        "DEPLOYMENT_SUCCESSFUL", 
        "DEPLOYMENT_FAILED", 
        "UNCONFIGURING_GATEWAY", 
        "RELEASING_EIPS", 
        "TERMINATING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "DELETING_CLOUD_RESOURCES", 
        "UNDEPLOYMENT_SUCCESSFUL", 
        "UNDEPLOYMENT_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Different states of gateway deployment", 
      "type": "string"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for gateway deployment/undeployment failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for gateway deployment/undeployment failure", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": false, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "gateway_instance_id": {
      "required": false, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }, 
    "gateway_lcp_connectivity_status": {
      "description": "Status of connectivity between NSX controller and public cloud gateway.\n", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Controller connectivity status", 
      "type": "string"
    }, 
    "gateway_mpa_connectivity_status": {
      "description": "Status of connectivity between NSX manager and public cloud gateway.\n", 
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Manager connectivity status", 
      "type": "string"
    }, 
    "gateway_name": {
      "required": false, 
      "title": "Name of the gateway instance", 
      "type": "string"
    }, 
    "gateway_node_id": {
      "required": false, 
      "title": "NSX Node ID of the public cloud gateway", 
      "type": "string"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway instance status", 
      "type": "string"
    }, 
    "gateway_tn_id": {
      "required": false, 
      "title": "NSX transport node id of the public cloud gateway", 
      "type": "string"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is an active gateway", 
      "type": "boolean"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "vpn_private_ip": {
      "description": "Private IP address of the virtual machine for VPN", 
      "readonly": true, 
      "required": false, 
      "title": "VPN Private IP address", 
      "type": "string"
    }
  }, 
  "title": "AWS gateway instance status", 
  "type": "object"
}

AwsGatewayStatus (type) 

{
  "additionalProperties": false, 
  "description": "Stores AWS gateway status related information", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AwsGatewayStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "gateway_cluster_id": {
      "description": "Cluster ID of NSX gateway", 
      "required": false, 
      "title": "NSX gateway cluster ID", 
      "type": "string"
    }, 
    "gateway_instances_status": {
      "description": "Array of gateway instances statuses", 
      "items": {
        "$ref": "AwsGatewayInstanceStatus"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Instances Status", 
      "type": "array"
    }
  }, 
  "title": "AWS Gateway Status", 
  "type": "object"
}

AwsGatewayUndeployConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AwsGatewayUndeployConfig", 
  "module_id": "AwsGatewayManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "account_id": {
      "required": true, 
      "title": "ID of the Aws account", 
      "type": "string"
    }, 
    "instance_id": {
      "required": true, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }
  }, 
  "title": "Aws gateway undeployment configuration", 
  "type": "object"
}

AwsGatewaysListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of Aws Gateways.\nMultiple parameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsGatewaysListRequestParameters", 
  "module_id": "AwsGatewayManagement", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which AWS gateways list can be\nfiltered.\n", 
      "required": false, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which AWS gateways list can be\nfiltered.\n", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Optional identifier for vpc based on which AWS gateways list can be\nfiltered.\n", 
      "required": false, 
      "title": "VPC ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsGatewaysListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsGatewaysListResult", 
  "module_id": "AwsGatewayManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsGatewayDeployConfig"+
      }, 
      "required": false, 
      "title": "Vpc list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AWS Gateways List Result", 
  "type": "object"
}

AwsKeyPair (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AwsKeyPair", 
  "module_id": "AwsResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the Aws Key Pair", 
      "type": "string"
    }
  }, 
  "title": "Aws Key Pair", 
  "type": "object"
}

AwsKeyPairList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsKeyPairList", 
  "module_id": "AwsResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsKeyPair"+
      }, 
      "required": false, 
      "title": "Aws Key Pairs list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Aws Key Pairs", 
  "type": "object"
}

AwsKeyPairListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of subnets.\nMultiple parameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsKeyPairListRequestParameters", 
  "module_id": "AwsResources", 
  "properties": {
    "account_id": {
      "required": true, 
      "title": "Identifier for account based on which list of key pairs will be obtained\n", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": true, 
      "title": "Identifier for region based on which list of key pairs will be obtained\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsPublicIpListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Aws public IPs.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsPublicIpListResult", 
  "module_id": "AwsResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Aws public IPs.\n", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "AWS public IP", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Aws Public IP List Result", 
  "type": "object"
}

AwsRegion (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AwsRegion", 
  "module_id": "AwsRegionInformation", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "associated_account_ids": {
      "description": "Array of associated AWS account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated AWS Account IDs", 
      "type": "array"
    }, 
    "availability_zones": {
      "items": {
        "$ref": "AwsAvailabilityZoneInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Availability zones under this region", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "gateway_stats": {
      "$ref": "GatewayStats"+, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway statistics"
    }, 
    "has_managed_vpc": {
      "readonly": true, 
      "required": false, 
      "title": "Has a managed VPC?", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vpc_stats": {
      "$ref": "VpcStats"+, 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }
  }, 
  "title": "Aws Region Information", 
  "type": "object"
}

AwsRegionsListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of regions.\nMultiple parameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsRegionsListRequestParameters", 
  "module_id": "AwsRegionInformation", 
  "properties": {
    "account_id": {
      "required": false, 
      "title": "Identifier for account based on which regions are to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which the list can be filtered or can be used\nto validate that hierarchy is correct\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsRegionsListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsRegionsListResult", 
  "module_id": "AwsRegionInformation", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsRegion"+
      }, 
      "required": false, 
      "title": "Aws Regions list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "AwsRegions list", 
  "type": "object"
}

AwsResourcesListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Aws resources. Multiple parameters\ncan be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsResourcesListRequestParameters", 
  "module_id": "AwsResources", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which resources are\nto be filtered.\n", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which resources\nare to be filtered.\n", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Aws Resource List Request Parameters", 
  "type": "object"
}

AwsSecurityGroup (type) 

{
  "description": "Stores Aws security group information.\n", 
  "extends": {
    "$ref": "CloudSecurityGroup"+
  }, 
  "id": "AwsSecurityGroup", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "security_group_id": {
      "description": "ID of the cloud security group.\n", 
      "required": false, 
      "title": "Security Group ID", 
      "type": "string"
    }, 
    "security_group_name": {
      "description": "Name of the cloud security group.\n", 
      "required": false, 
      "title": "Security Group Name", 
      "type": "string"
    }
  }, 
  "title": "Aws Security Group", 
  "type": "object"
}

AwsSecurityGroupsListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Aws security groups. Multiple parameters\ncan be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "AwsResourcesListRequestParameters"+
  }, 
  "id": "AwsSecurityGroupsListRequestParameters", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which resources are\nto be filtered.\n", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which resources\nare to be filtered.\n", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Optional identifier for region based on which resources\nare to be filtered.\n", 
      "required": true, 
      "title": "Region ID", 
      "type": "string"
    }
  }, 
  "title": "Aws Security Groups List Request Parameters", 
  "type": "object"
}

AwsSecurityGroupsListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Aws security groups.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsSecurityGroupsListResult", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Aws security groups.\n", 
      "items": {
        "$ref": "AwsSecurityGroup"+
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Aws Security Groups List Result", 
  "type": "object"
}

AwsSubnet (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource"+
  }, 
  "id": "AwsSubnet", 
  "module_id": "AwsResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "availability_zone": {
      "required": false, 
      "tilte": "Availability zone", 
      "type": "string"
    }, 
    "cidr": {
      "format": "ipv4_cidr_block", 
      "required": true, 
      "title": "IPV4 CIDR Block for the Vpc", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "required": true, 
      "title": "ID of subnet", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vpc_id": {
      "required": true, 
      "title": "ID of the vpc", 
      "type": "string"
    }
  }, 
  "title": "Aws subnet", 
  "type": "object"
}

AwsSubnetListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of subnets.\nMultiple parameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsSubnetListRequestParameters", 
  "module_id": "AwsResources", 
  "properties": {
    "account_id": {
      "required": true, 
      "title": "Identifier for account based on which subnets are to be filtered", 
      "type": "string"
    }, 
    "availability_zone_name": {
      "required": true, 
      "title": "Identifier for availability zone based on which subnets are to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_name": {
      "required": true, 
      "title": "Identifier for region based on which subnets are to be filtered", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "required": true, 
      "title": "Identifier for vpc based on which subnets are to be filtered", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsSubnetListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsSubnetListResult", 
  "module_id": "AwsResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsSubnet"+
      }, 
      "required": true, 
      "title": "Aws subnets list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Aws subnets list", 
  "type": "object"
}

AwsVirtualMachine (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about a AWS Virtual Machine", 
  "extends": {
    "$ref": "CloudVirtualMachine"+
  }, 
  "id": "AwsVirtualMachine", 
  "module_id": "CloudVirtualMachineInformation", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AwsVirtualMachine"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "agent_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "NO_AGENT"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Agent Status", 
      "type": "string"
    }, 
    "agent_version": {
      "readonly": true, 
      "required": false, 
      "title": "Agent version details", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated cloud account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Cloud Account IDs", 
      "type": "array"
    }, 
    "availability_zone": {
      "description": "AWS availability zone in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Availability Zone", 
      "type": "string"
    }, 
    "cloud_tags": {
      "items": {
        "$ref": "CloudTag"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cloud tags for the virtual machine", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "error_messages": {
      "description": "List of error messages identified. Returns only error messages\nidentified in the last 1 hour.\n", 
      "items": {
        "$ref": "ComputeInstanceErrorMessage"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of error messages", 
      "type": "array"
    }, 
    "gateway_ha_index": {
      "description": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "required": false, 
      "title": "Gateway HA Index", 
      "type": "integer"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_gateway": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this VM is a gateway node", 
      "type": "boolean"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this VM is an active gateway node", 
      "type": "boolean"
    }, 
    "logical_switch_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch display name", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "managed_by_nsx": {
      "readonly": true, 
      "required": true, 
      "title": "Indicate if vm is managed by NSX or not", 
      "type": "boolean"
    }, 
    "nsx_ip": {
      "readonly": true, 
      "required": false, 
      "title": "IP address provided by NSX", 
      "type": "string"
    }, 
    "os_details": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system details", 
      "type": "string"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system of the virtual machine", 
      "type": "string"
    }, 
    "power_state": {
      "description": "Indicates the power state of the virtual machine as returned by AWS.\n", 
      "enum": [
        "PENDING", 
        "RUNNING", 
        "SHUTTING_DOWN", 
        "TERMINATED", 
        "STOPPING", 
        "STOPPED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Power State", 
      "type": "string"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Indicates the quarantine state of the VM.\nQUARANTINED - This state implies VM is moved to quarantine security\ngroup because some threat has been detected.\nNOT_QUARANTINED - This state implies no quarantine action has been\ntaken.\nUNKNOWN - This state implies either quarantine policy is disabled or\nquarantine information is not available.\nOVERRIDDEN - This state implies VM is associated with vm_override_sg\nwhich overrides any action based on threat detection.\n", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "region": {
      "description": "AWS region in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Region", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource. Possible values are in the form of\nVirtualMachine prefixed by cloud name. For example,\nAwsVirtualMachine or AzureVirtualMachine.\n", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "threat_state": {
      "description": "Indicates the threat state of the VM.\nNORMAL - This state implies no threat has been detected and VM is\nfunctioning as expected.\nTHREAT - This state implies quarantine enabling threat has been\ndetected.\nINVALID - This state implies either VM is unmanaged or threat related\ninformation is not available.\n", 
      "enum": [
        "NORMAL", 
        "THREAT", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Threat State", 
      "type": "string"
    }, 
    "vm_extension_execution_status": {
      "description": "UNKNOWN - This is the default state. Indicates no information available\n          regarding extension execution. This can potentially occur for\n          a VM when agent is installed out of band or if\n          cloud_agent_automated_install_enabled flag is enabled for the\n          VNET/VPC which already has managed VMs.\nSUCCESSFUL - Indicates VM extension script execution was successful.\n          This does not necessarily mean agent installation was\n          successful.\nFAILED - Indicates VM extension script execution failed.\n", 
      "readonly": true, 
      "required": false, 
      "title": "VM extension script execution status", 
      "type": "string"
    }, 
    "vpc": {
      "description": "AWS VPC ID in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS VPC", 
      "type": "string"
    }, 
    "vpc_name": {
      "description": "AWS VPC name in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "AWS VPC name", 
      "type": "string"
    }
  }, 
  "title": "Aws Virtual Machine Information", 
  "type": "object"
}

AwsVpc (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AwsVpc", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "ami_id": {
      "description": "Amazon Machine Image is a special type of virtual appliance that is\nused to create a virtual machine with the Amazon Elastic Compute\nCloud. It serves as the basic unit of deployment for services\ndelivered using Amazon EC2\n", 
      "readonly": true, 
      "required": false, 
      "title": "AMI ID", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated AWS account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated AWS Account IDs", 
      "type": "array"
    }, 
    "cidr": {
      "deprecated": true, 
      "description": "This field is DEPRECATED as AWS started supporting multiple CIDR\nblocks per VPC. This field will return only the first CIDR block\nfrom the response received from AWS. Please use cidr_blocks to\nsee the multiple CIDR blocks associated with the VPC.\n", 
      "format": "ipv4-cidr-block", 
      "readonly": true, 
      "title": "IPV4 CIDR Block for the Vpc", 
      "type": "string"
    }, 
    "cidr_blocks": {
      "description": "IPv4 CIDR Block of the virtual network.", 
      "items": {
        "$ref": "CidrBlock"+
      }, 
      "readonly": true, 
      "title": "IPv4 CIDR Block", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "gateway_info": {
      "$ref": "AwsGatewayInfo"+, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway details for the Vpc"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "readonly": true, 
      "required": false, 
      "title": "Managed, unmanaged and error instance counts for the Vpc", 
      "type": "object"
    }, 
    "is_management_vpc": {
      "default": false, 
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is the management Vpc", 
      "type": "boolean"
    }, 
    "op_status": {
      "enum": [
        "NSX_MANAGED", 
        "NSX_UNMANAGED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "State of the Vpc", 
      "type": "string"
    }, 
    "region_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the AWS region", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zones": {
      "items": {
        "$ref": "TransportZoneInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Transport zones for the Vpc", 
      "type": "array"
    }
  }, 
  "title": "Vpc Information", 
  "type": "object"
}

AwsVpcListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of Vpcs.\nMultiple parameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AwsVpcListRequestParameters", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "account_id": {
      "required": false, 
      "title": "Identifier for account based on which vpcs are to be filtered", 
      "type": "string"
    }, 
    "cidr": {
      "format": "ipv4_cidr_block", 
      "required": false, 
      "title": "IPV4 CIDR Block for the Vpc", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "op_status": {
      "enum": [
        "NSX_MANAGED", 
        "NSX_UNMANAGED"
      ], 
      "required": false, 
      "title": "Identifier for state based on which vpcs are to be filtered", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": false, 
      "title": "Identifier for region based on which vpcs are to be filtered", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vpc_id": {
      "required": false, 
      "title": "Identifier for vpc based on which the list can be filtered or can be\nused to validate that hierarchy is correct\n", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AwsVpcListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AwsVpcListResult", 
  "module_id": "AwsVpcInformation", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AwsVpc"+
      }, 
      "required": false, 
      "title": "Vpc list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Vpc list", 
  "type": "object"
}

AzureAccount (type) 

{
  "additional_properties": false, 
  "description": "Stores information about an Azure account", 
  "extends": {
    "$ref": "CloudAccount"+
  }, 
  "id": "AzureAccount", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "auth_method": {
      "description": "This property conveys the authorization method to use. Appropriate\ncredentials/parameters will be expected based on this method selection.\n", 
      "enum": [
        "CREDENTIALS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Azure account authorization method", 
      "type": "string"
    }, 
    "auth_users": {
      "description": "List of authorized users.", 
      "items": {
        "$ref": "CloudUserInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Authrized Users", 
      "type": "array"
    }, 
    "cloud_tags_enabled": {
      "default": true, 
      "description": "Boolean flag to enable or disable cloud tags discovery. The discovered\ncloud tags can be used to define security group membership.\n", 
      "hidden": true, 
      "readonly": false, 
      "required": false, 
      "title": "Boolean flag to enable or disable cloud tags discovery", 
      "type": "boolean"
    }, 
    "cloud_type": {
      "decription": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "credentials": {
      "$ref": "AzureCredentials"+, 
      "description": "Credentials of Azure Account.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Credentials"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "has_managed_vnet": {
      "deprecated": true, 
      "description": "This field is DEPRECATED. Please use vnet_stats to get the number of\nmanaged virtual networks.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Has a managed virtual network?", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Stores statistics of the number of managed, unmanaged and error virtual\nmachines.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "regions_count": {
      "description": "Count of the regions accessible.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Regions Count", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "AzureAccountStatus"+, 
      "description": "Status of the Azure Account.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Account Status"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the cloud account.", 
      "readonly": true, 
      "required": false, 
      "title": "Tenant ID", 
      "type": "string"
    }, 
    "vnet_stats": {
      "$ref": "VnetStats"+, 
      "description": "Stores statistics of the number of MANAGED and UNMANAGED virtual\nnetworks.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Network Statistics"
    }
  }, 
  "title": "Azure Account", 
  "type": "object"
}

AzureAccountStatus (type) 

{
  "additional_properties": false, 
  "description": "Stores information about Azure account status.", 
  "extends": {
    "$ref": "CloudAccountStatus"+
  }, 
  "id": "AzureAccountStatus", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "credentials_status": {
      "description": "Status of the cloud account credentials synced at the auto interval.\n", 
      "enum": [
        "VALID", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Credentials Status", 
      "type": "string"
    }, 
    "error_message": {
      "description": "Error encountered while syncing azure inventory such as read timeout.", 
      "readonly": true, 
      "required": false, 
      "title": "Error encountered while syncing azure inventory", 
      "type": "string"
    }, 
    "inventory_sync_status": {
      "description": "Status of inventory synchronization process.", 
      "enum": [
        "SYNCED", 
        "IN_PROGRESS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory Synchronization Status", 
      "type": "string"
    }, 
    "inventory_sync_step": {
      "description": "Step of the inventory synchronization process.", 
      "enum": [
        "SYNCING_AZURE_REGIONS", 
        "SYNCING_AZURE_VNETS", 
        "SYNCING_VMS", 
        "SYNCING_NSX_DATA", 
        "SYNCING_AZURE_GATEWAYS", 
        "SYNCING_MANAGED_INSTANCES", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory sync step", 
      "type": "string"
    }
  }, 
  "title": "Azure Account Status", 
  "type": "object"
}

AzureAccountsListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure accounts.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureAccountsListResult", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure accounts.", 
      "items": {
        "$ref": "AzureAccount"+
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Accounts List Result", 
  "type": "object"
}

AzureCredentials (type) 

{
  "additional_properties": false, 
  "description": "Stores information about Azure account credentials", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AzureCredentials", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "client_id": {
      "description": "Client ID of the Azure account.", 
      "readonly": false, 
      "required": false, 
      "title": "Azure Account Client ID", 
      "type": "string"
    }, 
    "gateway_role": {
      "description": "Default Azure Managed Service Identity role that will be set to the\nCloud Gateways deployed in the Azure account. Based on the permissions\nin the role, the gateways will have access to resources in the Azure\naccount.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Azure role name for gateway", 
      "type": "string"
    }, 
    "key": {
      "description": "Key of the Azure account. Used only to take input. Will never be\nreturned in any API response.\n", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "title": "Azure Account Key", 
      "type": "string"
    }, 
    "subscription_id": {
      "description": "Subscription ID of the Azure account.", 
      "readonly": false, 
      "required": false, 
      "title": "Azure Account Subscription ID", 
      "type": "string"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the Azure account.", 
      "readonly": false, 
      "required": false, 
      "title": "Azure Account Tenant ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Account Credentials", 
  "type": "object"
}

AzureGatewayConfig (type) 

{
  "additionalProperties": false, 
  "description": "Stores Azure gateway configuration like image_id, ssh_key and\ngateway_ha_configuration.\n", 
  "extends": {
    "$ref": "GatewayConfig"+
  }, 
  "id": "AzureGatewayConfig", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "auto_agent_install_enabled": {
      "default": false, 
      "description": "Flag to identify if NSX agent installation will be done automatically or not.\nAs of now this is supported for Azure Cloud only.\n", 
      "required": false, 
      "title": "Auto Agent Install Enabled", 
      "type": "boolean"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway\nundeployed.\n", 
      "required": false, 
      "title": "Id of cloud security group", 
      "type": "string"
    }, 
    "default_quarantine_policy_enabled": {
      "required": false, 
      "title": "Flag to identify if default quarantine policy is enabled", 
      "type": "boolean"
    }, 
    "dns_settings": {
      "$ref": "DnsSettings"+, 
      "description": "Settings related to Cloud gateway DNS configuration. This determines\nDNS configuration based on dns_mode.\n", 
      "title": "DNS settings"
    }, 
    "gateway_ha_configuration": {
      "items": {
        "$ref": "AzureGatewayHaConfig"+
      }, 
      "required": false, 
      "title": "Azure Gateway HA configuration", 
      "type": "array"
    }, 
    "image_id": {
      "description": "The ID of the Public Cloud Gateway image in Azure\n", 
      "required": false, 
      "title": "NSX PCG Image ID", 
      "type": "string"
    }, 
    "is_ha_enabled": {
      "required": false, 
      "title": "Flag to identify if HA is enabled", 
      "type": "boolean"
    }, 
    "nsx_manager_connection": {
      "description": "Determines if connection to NSX Manager is via public IP or private IP\n", 
      "enum": [
        "PUBLIC_IP", 
        "PRIVATE_IP"
      ], 
      "required": false, 
      "title": "NSX Manager connection", 
      "type": "string"
    }, 
    "proxy_server_profile": {
      "description": "Id of the proxy server profile, corresponding proxy settings\nwill be applied while deploying the gateway.\n", 
      "required": false, 
      "title": "Id of the proxy server profile", 
      "type": "string"
    }, 
    "ssh_key": {
      "description": "This key will be associated to Public Cloud Gateway instance while\nit is launched in Azure.\n", 
      "required": false, 
      "title": "SSH Key", 
      "type": "string"
    }, 
    "storage_account_name": {
      "description": "Azure Storage Account where gateway image will be copied.\n", 
      "required": false, 
      "title": "Azure Storage Account Name", 
      "type": "string"
    }, 
    "vpn_service_enabled": {
      "default": true, 
      "description": "Flag that will enable or disable inter-operation between NSX and\nnon-NSX services via VPN.\n", 
      "required": false, 
      "title": "Flag to enable or disable inter-operation with services via VPN", 
      "type": "boolean"
    }
  }, 
  "title": "Azure gateway configuration", 
  "type": "object"
}

AzureGatewayDeployConfig (type) 

{
  "additionalProperties": false, 
  "description": "Stores configuration for Azure gateway deployment request.", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AzureGatewayDeployConfig", 
  "module_id": "AzureGatewayManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "account_id": {
      "description": "ID of the Azure account.", 
      "required": true, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "configuration": {
      "$ref": "AzureGatewayConfig"+, 
      "description": "Configuration of Azure gateway.", 
      "readonly": false, 
      "required": true, 
      "title": "Azure Gateway Configuration"
    }, 
    "vnet_id": {
      "description": "ID of the Azure Virtual Network. It consists of resourceGuid of Azure Vnet.", 
      "required": true, 
      "title": "Azure Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure gateway deployment configuration", 
  "type": "object"
}

AzureGatewayHaConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AzureGatewayHaConfig", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "downlink_subnet": {
      "required": true, 
      "title": "Downlink subnet", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": true, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "management_subnet": {
      "required": true, 
      "title": "Management subnet", 
      "type": "string"
    }, 
    "public_ip_settings": {
      "$ref": "GatewayPublicIp"+, 
      "description": "Stores settings related to Azure gateway Public IP configuration.\nThe public_ip will be attached for management interface of the gateway.\n", 
      "required": false, 
      "title": "Public IP settings"
    }, 
    "uplink_public_ip_settings": {
      "$ref": "GatewayPublicIp"+, 
      "description": "Stores settings related to Azure gateway Public IP configuration.\nThe public_ip will be attached to uplink interface of\nthe primary gateway, based on the value of ip_allocation_mode.\n", 
      "required": false, 
      "title": "Public IP settings for uplink interface"
    }, 
    "uplink_subnet": {
      "required": true, 
      "title": "Uplink subnet", 
      "type": "string"
    }
  }, 
  "title": "Azure subnet configuration to deploy gateways", 
  "type": "object"
}

AzureGatewayInfo (type) 

{
  "additionalProperties": false, 
  "description": "Stores azure gateway information like configuration and status.", 
  "id": "AzureGatewayInfo", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "configuration": {
      "$ref": "AzureGatewayConfig"+, 
      "description": "Configuration of Azure gateway.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Configuration"
    }, 
    "csm_ip_address": {
      "description": "Cloud service manager IP address used to communicate\nwith the Azure Vnet gateways.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Cloud service manager IP address", 
      "type": "string"
    }, 
    "gateway_status": {
      "$ref": "AzureGatewayStatus"+, 
      "description": "Array of gateway statuses.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status"
    }
  }, 
  "title": "Azure Gateway Information", 
  "type": "object"
}

AzureGatewayInstanceStatus (type) 

{
  "description": "Stores information about Azure gateway instance status", 
  "extends": {
    "$ref": "GatewayInstanceStatus"+
  }, 
  "id": "AzureGatewayInstanceStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "azure_image_bytes_copied": {
      "description": "Displays number of bytes copied, while copying gateway image.", 
      "readonly": true, 
      "required": false, 
      "title": "Bytes copied, while copying image", 
      "type": "integer"
    }, 
    "azure_image_copy_progress": {
      "description": "Displays progress percentage while copying gateway image.", 
      "readonly": true, 
      "required": false, 
      "title": "Progress Percentage for image copy", 
      "type": "integer"
    }, 
    "azure_image_total_bytes": {
      "description": "Displays total number of bytes required to be copied, for copying gateway image.", 
      "readonly": true, 
      "required": false, 
      "title": "Total bytes required to be copied, for copying image", 
      "type": "integer"
    }, 
    "deployment_step": {
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "COPYING_IMAGE", 
        "CREATING_SECURITY_GROUPS", 
        "LAUNCHING_GATEWAY", 
        "CREATING_NETWORK_INTERFACES", 
        "ATTACHING_NETWORK_INTERFACES", 
        "ATTACHING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "CREATING_LOGICAL_NETWORK_CONSTRUCTS", 
        "DEPLOYMENT_SUCCESSFUL", 
        "DEPLOYMENT_FAILED", 
        "UNCONFIGURING_GATEWAY", 
        "RELEASING_EIPS", 
        "TERMINATING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "DELETING_CLOUD_RESOURCES", 
        "UNDEPLOYMENT_SUCCESSFUL", 
        "UNDEPLOYMENT_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Different states of gateway deployment", 
      "type": "string"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for gateway deployment/undeployment failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for gateway deployment/undeployment failure", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": false, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "gateway_instance_id": {
      "required": false, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }, 
    "gateway_lcp_connectivity_status": {
      "description": "Status of connectivity between NSX controller and public cloud gateway.\n", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Controller connectivity status", 
      "type": "string"
    }, 
    "gateway_mpa_connectivity_status": {
      "description": "Status of connectivity between NSX manager and public cloud gateway.\n", 
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Manager connectivity status", 
      "type": "string"
    }, 
    "gateway_name": {
      "required": false, 
      "title": "Name of the gateway instance", 
      "type": "string"
    }, 
    "gateway_node_id": {
      "required": false, 
      "title": "NSX Node ID of the public cloud gateway", 
      "type": "string"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway instance status", 
      "type": "string"
    }, 
    "gateway_tn_id": {
      "required": false, 
      "title": "NSX transport node id of the public cloud gateway", 
      "type": "string"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is an active gateway", 
      "type": "boolean"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "vpn_private_ip": {
      "description": "Private IP address of the virtual machine for VPN", 
      "readonly": true, 
      "required": false, 
      "title": "VPN Private IP address", 
      "type": "string"
    }
  }, 
  "title": "Azure gateway instance status", 
  "type": "object"
}

AzureGatewayStatus (type) 

{
  "additionalProperties": false, 
  "description": "Stores Azure gateway status related information", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AzureGatewayStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "gateway_cluster_id": {
      "description": "Cluster ID of NSX gateway", 
      "required": false, 
      "title": "NSX gateway cluster ID", 
      "type": "string"
    }, 
    "gateway_instances_status": {
      "description": "Array of gateway instances statuses", 
      "items": {
        "$ref": "AzureGatewayInstanceStatus"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Instances Status", 
      "type": "array"
    }
  }, 
  "title": "Azure Gateway Status", 
  "type": "object"
}

AzureGatewayUndeployConfig (type) 

{
  "additionalProperties": false, 
  "description": "Stores configuration for Azure gateway undeployment request.", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AzureGatewayUndeployConfig", 
  "module_id": "AzureGatewayManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "account_id": {
      "description": "ID of the Azure account.", 
      "required": true, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "instance_id": {
      "description": "ID of the gateway instance.", 
      "required": true, 
      "title": "Azure Instance ID", 
      "type": "string"
    }
  }, 
  "title": "Azure gateway undeployment configuration", 
  "type": "object"
}

AzureGatewaysListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list Azure gateways. Multiple\nparameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AzureGatewaysListRequestParameters", 
  "module_id": "AzureGatewayManagement", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which Azure gateways list can\nbe filtered.\n", 
      "required": false, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which Azure Gateways list can\nbe filtered.\n", 
      "required": false, 
      "title": "Azure Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for virtual network based on which Azure Gateways\nlist can be filtered. It consists of resourceGuid of Azure Vnet.\n", 
      "required": false, 
      "title": "Azure Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Gateways List Request Parameters", 
  "type": "object"
}

AzureGatewaysListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure gateways.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureGatewaysListResult", 
  "module_id": "AzureGatewayManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure gateways.", 
      "items": {
        "$ref": "AzureGatewayDeployConfig"+
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Gateways List Result", 
  "type": "object"
}

AzurePublicIpListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Azure Public IPs. Multiple parameters\ncan be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AzurePublicIpListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which public IPs are\nto be filtered.\n", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which public IPs\nare to be filtered.\n", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Public IP List Request Parameters", 
  "type": "object"
}

AzurePublicIpListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure public IPs.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzurePublicIpListResult", 
  "module_id": "AzureResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure Public IPs.\n", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Azure Public IP", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Public IP List Result", 
  "type": "object"
}

AzureRegion (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure region.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AzureRegion", 
  "module_id": "AzureRegionInformation", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "associated_account_ids": {
      "description": "Array of associated Azure account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Azure Account IDs", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "gateway_stats": {
      "$ref": "GatewayStats"+, 
      "description": "Stores statistics of the number of UP, DOWN and DEPLOYING gateways.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Statistics"
    }, 
    "has_managed_vnet": {
      "readonly": true, 
      "required": false, 
      "title": "Has a managed Virtual Network?", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Stores statistics of the number of MANAGED, UNMANAGED and ERROR instances.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vnet_stats": {
      "$ref": "VnetStats"+, 
      "description": "Stores statistics of the number of MANAGED and UNMANAGED virtual networks.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Virtual Network Statistics"
    }
  }, 
  "title": "Azure Region Information", 
  "type": "object"
}

AzureRegionsListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list Azure regions. Multiple\nparameters can be given as input to use 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AzureRegionsListRequestParameters", 
  "module_id": "AzureRegionInformation", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which regions list can be\nfiltered.\n", 
      "required": false, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which the regions list can be\nfiltered.\n", 
      "required": false, 
      "title": "Azure Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Regions List Request Parameters", 
  "type": "object"
}

AzureRegionsListResult (type) 

{
  "additionalProperties": false, 
  "description": "A list of Azure regions.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureRegionsListResult", 
  "module_id": "AzureRegionInformation", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure regions.", 
      "items": {
        "$ref": "AzureRegion"+
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Regions List Result", 
  "type": "object"
}

AzureResourceGroup (type) 

{
  "additionalProperties": false, 
  "description": "Stores Azure resource group information.\n", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AzureResourceGroup", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "resource_group_id": {
      "description": "Id of resource group.\n", 
      "required": false, 
      "title": "Id of resource group", 
      "type": "string"
    }, 
    "resource_group_name": {
      "description": "Name of resource group.\n", 
      "required": false, 
      "title": "Name of resource group", 
      "type": "string"
    }
  }, 
  "title": "Azure Resource Group", 
  "type": "object"
}

AzureResourceGroupsListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure resource groups.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureResourceGroupsListResult", 
  "module_id": "AzureResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure resource groups.\n", 
      "items": {
        "$ref": "AzureResourceGroup"+
      }, 
      "required": true, 
      "title": "Azure resource groups Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Resource Groups List Result", 
  "type": "object"
}

AzureResourcesListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Azure resources. Multiple parameters\ncan be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AzureResourcesListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which resources are\nto be filtered.\n", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which resources\nare to be filtered.\n", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_group_id": {
      "description": "Optional identifier for resource group id based on which resources\nare to be filtered.\n", 
      "required": false, 
      "title": "Resource Group ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Resource List Request Parameters", 
  "type": "object"
}

AzureSecurityGroup (type) 

{
  "description": "Stores Azure security group information.\n", 
  "extends": {
    "$ref": "CloudSecurityGroup"+
  }, 
  "id": "AzureSecurityGroup", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "security_group_id": {
      "description": "ID of the cloud security group.\n", 
      "required": false, 
      "title": "Security Group ID", 
      "type": "string"
    }, 
    "security_group_name": {
      "description": "Name of the cloud security group.\n", 
      "required": false, 
      "title": "Security Group Name", 
      "type": "string"
    }
  }, 
  "title": "Azure Security Group", 
  "type": "object"
}

AzureSecurityGroupsListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure secuity groups.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureSecurityGroupsListResult", 
  "module_id": "AzureResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure security groups.\n", 
      "items": {
        "$ref": "AzureSecurityGroup"+
      }, 
      "required": true, 
      "title": "Azure security groups Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure Secuirty Groups List Result", 
  "type": "object"
}

AzureStorageAccount (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "AzureStorageAccount", 
  "module_id": "AzureResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the Azure Storage Account", 
      "type": "string"
    }
  }, 
  "title": "Azure Storage Account", 
  "type": "object"
}

AzureStorageAccountList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureStorageAccountList", 
  "module_id": "AzureResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "AzureStorageAccount"+
      }, 
      "required": false, 
      "title": "Azure Storage Accounts list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Azure Storage Accounts", 
  "type": "object"
}

AzureStorageAccountsListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of storage accounts.\nMultiple parameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AzureStorageAccountsListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "required": true, 
      "title": "Identifier for account based on which list of storage accounts will be obtained\n", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "required": true, 
      "title": "Identifier for region based on which list of storage accounts will be obtained\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AzureSubnet (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure subnet.", 
  "extends": {
    "$ref": "DiscoveredResource"+
  }, 
  "id": "AzureSubnet", 
  "module_id": "AzureResources", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "address_space": {
      "format": "Address space of the subnet in IPv4 CIDR block format.", 
      "readonly": true, 
      "title": "Azure subnet address space", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "desription": "Stores the ID of the subnet.", 
      "readonly": true, 
      "title": "ID of Subnet", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vnet_id": {
      "description": "ID of the Azure Virtual Network.It consists of resourceGuid of Azure Vnet.", 
      "readonly": true, 
      "title": "Azure Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Subnet", 
  "type": "object"
}

AzureSubnetListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of filter parameters to list Azure subnets. Multiple parameters can\nbe given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AzureSubnetListRequestParameters", 
  "module_id": "AzureResources", 
  "properties": {
    "account_id": {
      "description": "Mandatory identifier for account based on which subnets are to be filtered.\n", 
      "required": true, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Identifier for region based on which subnets are to be filtered.\n", 
      "required": true, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Identifier for vnet based on which subnets are to be filtered. It consists of resourceGuid of Azure Vnet.\n", 
      "required": true, 
      "title": "Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure Subnet List Request Parameters", 
  "type": "object"
}

AzureSubnetListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure subnets.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureSubnetListResult", 
  "module_id": "AzureResources", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure subnets.\n", 
      "items": {
        "$ref": "AzureSubnet"+
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure subnets List Result", 
  "type": "object"
}

AzureVirtualMachine (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about a Azure Virtual Machine", 
  "extends": {
    "$ref": "CloudVirtualMachine"+
  }, 
  "id": "AzureVirtualMachine", 
  "module_id": "CloudVirtualMachineInformation", 
  "polymorphic-type-descriptor": {
    "type-identifier": "AzureVirtualMachine"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "agent_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "NO_AGENT"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Agent Status", 
      "type": "string"
    }, 
    "agent_version": {
      "readonly": true, 
      "required": false, 
      "title": "Agent version details", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated cloud account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Cloud Account IDs", 
      "type": "array"
    }, 
    "cloud_tags": {
      "items": {
        "$ref": "CloudTag"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cloud tags for the virtual machine", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "error_messages": {
      "description": "List of error messages identified. Returns only error messages\nidentified in the last 1 hour.\n", 
      "items": {
        "$ref": "ComputeInstanceErrorMessage"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of error messages", 
      "type": "array"
    }, 
    "gateway_ha_index": {
      "description": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "required": false, 
      "title": "Gateway HA Index", 
      "type": "integer"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_gateway": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this VM is a gateway node", 
      "type": "boolean"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this VM is an active gateway node", 
      "type": "boolean"
    }, 
    "logical_switch_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch display name", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "managed_by_nsx": {
      "readonly": true, 
      "required": true, 
      "title": "Indicate if vm is managed by NSX or not", 
      "type": "boolean"
    }, 
    "nsx_ip": {
      "readonly": true, 
      "required": false, 
      "title": "IP address provided by NSX", 
      "type": "string"
    }, 
    "os_details": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system details", 
      "type": "string"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system of the virtual machine", 
      "type": "string"
    }, 
    "power_state": {
      "description": "Indicates power state of the virtual machine as returned by Azure.\n", 
      "enum": [
        "RUNNING", 
        "DEALLOCATING", 
        "DEALLOCATED", 
        "STARTING", 
        "STOPPED", 
        "STOPPING", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Power State", 
      "type": "string"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Indicates the quarantine state of the VM.\nQUARANTINED - This state implies VM is moved to quarantine security\ngroup because some threat has been detected.\nNOT_QUARANTINED - This state implies no quarantine action has been\ntaken.\nUNKNOWN - This state implies either quarantine policy is disabled or\nquarantine information is not available.\nOVERRIDDEN - This state implies VM is associated with vm_override_sg\nwhich overrides any action based on threat detection.\n", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "region": {
      "description": "Azure region in which virtual machine is residing", 
      "readonly": true, 
      "required": false, 
      "title": "Azure region", 
      "type": "string"
    }, 
    "resource_group": {
      "description": "Resource Group of the Azure Virtual Machine.", 
      "readonly": true, 
      "required": false, 
      "title": "Resource Group", 
      "type": "string"
    }, 
    "resource_id": {
      "description": "Resource Id of Azure Virtual Machine.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Virtual Machine resource id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource. Possible values are in the form of\nVirtualMachine prefixed by cloud name. For example,\nAwsVirtualMachine or AzureVirtualMachine.\n", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "threat_state": {
      "description": "Indicates the threat state of the VM.\nNORMAL - This state implies no threat has been detected and VM is\nfunctioning as expected.\nTHREAT - This state implies quarantine enabling threat has been\ndetected.\nINVALID - This state implies either VM is unmanaged or threat related\ninformation is not available.\n", 
      "enum": [
        "NORMAL", 
        "THREAT", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Threat State", 
      "type": "string"
    }, 
    "vm_extension_execution_status": {
      "description": "UNKNOWN - This is the default state. Indicates no information available\n          regarding extension execution. This can potentially occur for\n          a VM when agent is installed out of band or if\n          cloud_agent_automated_install_enabled flag is enabled for the\n          VNET/VPC which already has managed VMs.\nSUCCESSFUL - Indicates VM extension script execution was successful.\n          This does not necessarily mean agent installation was\n          successful.\nFAILED - Indicates VM extension script execution failed.\n", 
      "readonly": true, 
      "required": false, 
      "title": "VM extension script execution status", 
      "type": "string"
    }, 
    "vnet": {
      "description": "Azure virtual network ID in which virtual machine is residing\n", 
      "readonly": true, 
      "required": false, 
      "title": "Azure virtual network", 
      "type": "string"
    }, 
    "vnet_name": {
      "description": "Azure virtual network name in which virtual machine is residing\n", 
      "readonly": true, 
      "required": false, 
      "title": "Azure virtual network name", 
      "type": "string"
    }
  }, 
  "title": "Azure Virtual Machine Information", 
  "type": "object"
}

AzureVnet (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about an Azure VNet (Virtual Network).", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "AzureVnet", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "agent_info": {
      "description": "Array of agent install and download instructions for various OS types.", 
      "items": {
        "$ref": "AgentInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Azure Agent Information", 
      "type": "array"
    }, 
    "associated_account_ids": {
      "description": "Array of associated Azure account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Azure Account IDs", 
      "type": "array"
    }, 
    "cidr_blocks": {
      "description": "IPv4 CIDR Block of the virtual network.", 
      "items": {
        "$ref": "CidrBlock"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "IPv4 CIDR Block", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "gateway_info": {
      "$ref": "AzureGatewayInfo"+, 
      "description": "Gateway information of the virtual network like configuration and status.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Info"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Stores statistics of the number of MANAGED, MANAGED and ERROR instances.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance Statistics", 
      "type": "object"
    }, 
    "is_management_vnet": {
      "default": false, 
      "description": "This flag indicates if this is a management virtual network.", 
      "readonly": true, 
      "required": false, 
      "title": "Is Management VNet?", 
      "type": "boolean"
    }, 
    "op_status": {
      "description": "Operational status of the virtual network.", 
      "enum": [
        "NSX_MANAGED", 
        "NSX_UNMANAGED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Operational Status", 
      "type": "string"
    }, 
    "region_id": {
      "description": "ID of the Azure region.", 
      "readonly": true, 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_group": {
      "description": "Resource Group of the Azure Vnet.", 
      "readonly": true, 
      "required": false, 
      "title": "Resource Group", 
      "type": "string"
    }, 
    "resource_id": {
      "description": "Resource Id of Azure Vnet.", 
      "readonly": true, 
      "required": false, 
      "title": "Azure Vnet resource id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "storage_account_name": {
      "description": "Azure Storage Account where gateway image will be copied.", 
      "required": false, 
      "title": "Azure Storage Account Name", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zones": {
      "description": "Array of transport zones in the virtual network.", 
      "items": {
        "$ref": "TransportZoneInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Transport Zones", 
      "type": "array"
    }
  }, 
  "title": "Azure VNet", 
  "type": "object"
}

AzureVnetListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list Azure virtual networks.\nMultiple parameters can be given as input to 'AND' them.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "AzureVnetListRequestParameters", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which virtual networks list\ncan be filtered.\n", 
      "required": false, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cidr": {
      "$ref": "CidrBlock"+, 
      "description": "Optional identifier for IPv4 CIDR Block based on which virtual networks\nlist can be filtered.\n", 
      "format": "ipv4_cidr_block", 
      "required": false, 
      "title": "IPv4 CIDR Block"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "op_status": {
      "description": "Optional identifier for operational status based on which virtual\nnetworks list can be filtered.\n", 
      "enum": [
        "NSX_MANAGED", 
        "NSX_UNMANAGED"
      ], 
      "required": false, 
      "title": "Operational Status", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "region_id": {
      "description": "Optional identifier for region based on which virtual networks list can\nbe filtered.\n", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for virtual network based on which virtual networks\nlist can be filtered. It consists of resourceGuid of Azure Vnet.\n", 
      "required": false, 
      "title": "Virtual Network ID", 
      "type": "string"
    }
  }, 
  "title": "Azure VNet List Request Parameters", 
  "type": "object"
}

AzureVnetListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of Azure virtual networks.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "AzureVnetListResult", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of Azure virtual networks.", 
      "items": {
        "$ref": "AzureVnet"+
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Azure VNet List Result", 
  "type": "object"
}

BFDDiagnosticCount (type) 

{
  "additionalProperties": false, 
  "id": "BFDDiagnosticCount", 
  "module_id": "Heatmap", 
  "properties": {
    "administratively_down_count": {
      "title": "Number of tunnels with administratively down diagnostic message", 
      "type": "integer"
    }, 
    "concatenated_path_down_count": {
      "title": "Number of tunnels with concatenated path down diagnostic message", 
      "type": "integer"
    }, 
    "control_detection_time_expired_count": {
      "title": "Number of tunnels with control detection time expired diagnostic message", 
      "type": "integer"
    }, 
    "echo_function_failed_count": {
      "title": "Number of tunnels with echo function failed diagnostic message", 
      "type": "integer"
    }, 
    "forwarding_plane_reset_count": {
      "title": "Number of tunnels with forwarding plane reset diagnostic message", 
      "type": "integer"
    }, 
    "neighbor_signaled_session_down_count": {
      "title": "Number of tunnels neighbor signaled session down", 
      "type": "integer"
    }, 
    "no_diagnostic_count": {
      "title": "Number of tunnels with no diagnostic", 
      "type": "integer"
    }, 
    "path_down_count": {
      "title": "Number of tunnels with path down diagnostic message", 
      "type": "integer"
    }, 
    "reverse_concatenated_path_down_count": {
      "title": "Number of tunnels with reverse concatenated path down diagnostic message", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

BFDProperties (type) 

{
  "additionalProperties": false, 
  "id": "BFDProperties", 
  "module_id": "Tunnel", 
  "properties": {
    "active": {
      "readonly": true, 
      "required": false, 
      "title": "True if tunnel is active in a gateway HA setup", 
      "type": "boolean"
    }, 
    "diagnostic": {
      "description": "A short message indicating what the BFD session thinks is wrong in case of a problem", 
      "readonly": true, 
      "required": false, 
      "title": "Diagnostic message of a problem", 
      "type": "string"
    }, 
    "forwarding": {
      "readonly": true, 
      "required": false, 
      "title": "True if the BFD session believes this interface may be used to forward traffic", 
      "type": "boolean"
    }, 
    "remote_diagnostic": {
      "description": "A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem", 
      "readonly": true, 
      "required": false, 
      "title": "Diagnostic message of a problem", 
      "type": "string"
    }, 
    "remote_state": {
      "enum": [
        "UNKNOWN_STATE", 
        "ADMIN_DOWN", 
        "DOWN", 
        "INIT", 
        "UP"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "State of the remote interface's BFD session", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNKNOWN_STATE", 
        "ADMIN_DOWN", 
        "DOWN", 
        "INIT", 
        "UP"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "State of the BFD session", 
      "type": "string"
    }
  }, 
  "title": "BFD information", 
  "type": "object"
}

BFDStatusCount (type) 

{
  "additionalProperties": false, 
  "id": "BFDStatusCount", 
  "module_id": "Heatmap", 
  "properties": {
    "bfd_admin_down_count": {
      "title": "Number of tunnels in BFD admin down state", 
      "type": "int"
    }, 
    "bfd_down_count": {
      "title": "Number of tunnels in BFD down state", 
      "type": "int"
    }, 
    "bfd_init_count": {
      "title": "Number of tunnels in BFD init state", 
      "type": "int"
    }, 
    "bfd_up_count": {
      "title": "Number of tunnels in BFD up state", 
      "type": "int"
    }
  }, 
  "type": "object"
}

BGPCommunityList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BGPCommunityList", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "communities": {
      "description": "Array of BGP communities", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "BGP community list", 
      "type": "array"
    }, 
    "community_type": {
      "default": "NormalBGPCommunity", 
      "description": "Specifies the BGP community type. Currently, only NormalBGPCommunity is\nsupported.\n", 
      "enum": [
        "NormalBGPCommunity"
      ], 
      "title": "BGP community type", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BGPCommunityListListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "BGPCommunityListListResult", 
  "module_id": "Routing", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Paginated list of bgp community lists", 
      "items": {
        "$ref": "BGPCommunityList"+
      }, 
      "required": false, 
      "title": "List of bgp communities", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BackupConfiguration (type) 

{
  "additionalProperties": false, 
  "id": "BackupConfiguration", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "backup_enabled": {
      "default": false, 
      "title": "true if automated backup is enabled", 
      "type": "boolean"
    }, 
    "backup_schedule": {
      "$ref": "BackupSchedule"+, 
      "title": "Set when backups should be taken - on a weekly schedule or at regular intervals."
    }, 
    "inventory_summary_interval": {
      "default": 300, 
      "maximum": 3600, 
      "minimum": 30, 
      "title": "The minimum number of seconds between each upload of the inventory summary to backup server.", 
      "type": "integer"
    }, 
    "passphrase": {
      "sensitive": true, 
      "title": "Passphrase used to encrypt backup files.", 
      "type": "string"
    }, 
    "remote_file_server": {
      "$ref": "RemoteFileServer"+, 
      "required": true, 
      "title": "The server to which backups will be sent."
    }
  }, 
  "title": "Configuration for taking manual/automated backup", 
  "type": "object"
}

BackupOperationHistory (type) 

{
  "additionalProperties": false, 
  "id": "BackupOperationHistory", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "cluster_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus"+
      }, 
      "required": false, 
      "title": "Statuses of previous cluser backups", 
      "type": "array"
    }, 
    "inventory_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus"+
      }, 
      "required": false, 
      "title": "Statuses of previous inventory backups", 
      "type": "array"
    }, 
    "node_backup_statuses": {
      "items": {
        "$ref": "BackupOperationStatus"+
      }, 
      "required": false, 
      "title": "Statuses of previous node backups", 
      "type": "array"
    }
  }, 
  "title": "Past backup operation details", 
  "type": "object"
}

BackupOperationStatus (type) 

{
  "additionalProperties": false, 
  "id": "BackupOperationStatus", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "backup_id": {
      "required": true, 
      "title": "Unique identifier of a backup", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "Time when operation was ended"
    }, 
    "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"
      ], 
      "required": false, 
      "title": "Error code", 
      "type": "string"
    }, 
    "error_message": {
      "required": false, 
      "title": "Error code details", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "Time when operation was started"
    }, 
    "success": {
      "required": true, 
      "title": "True if backup is successfully completed, else false", 
      "type": "boolean"
    }
  }, 
  "readOnly": true, 
  "title": "Backup operation status", 
  "type": "object"
}

BackupSchedule (type) 

{
  "abstract": true, 
  "id": "BackupSchedule", 
  "module_id": "BackupConfiguration", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "WeeklyBackupSchedule", 
        "IntervalBackupSchedule"
      ], 
      "required": true, 
      "title": "Schedule type", 
      "type": "string"
    }
  }, 
  "title": "Abstract base type for Weekly or Interval Backup Schedule", 
  "type": "object"
}

BaseHostSwitchProfile (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BaseHostSwitchProfile", 
  "module_id": "BaseHostSwitchProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "HostSwitchProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BaseNodeAggregateInfo (type) 

{
  "additionalProperties": false, 
  "id": "BaseNodeAggregateInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "display_name": {
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "node_interface_properties": {
      "items": {
        "$ref": "NodeInterfaceProperties"+
      }, 
      "readonly": true, 
      "title": "Array of Node interface statistic properties", 
      "type": "array"
    }, 
    "node_interface_statistics": {
      "items": {
        "$ref": "NodeInterfaceStatisticsProperties"+
      }, 
      "readonly": true, 
      "title": "Array of Node network interface statistic properties", 
      "type": "array"
    }, 
    "node_status": {
      "$ref": "ClusterNodeStatus"+, 
      "readonly": true
    }, 
    "node_status_properties": {
      "items": {
        "$ref": "NodeStatusProperties"+
      }, 
      "title": "Time series of the node's system properties", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BaseServiceInstance (type) 

{
  "abstract": true, 
  "description": "The deployment of a registered service. service instance is instantiation of service.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BaseServiceInstance", 
  "module_id": "ServiceInsertionCommonTypes", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "on_failure_policy": {
      "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.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "required": false, 
      "title": "On Failure Policy", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ServiceInstanceResourceType"+, 
      "required": true
    }, 
    "service_id": {
      "description": "The Service to which the service instance is associated.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "description": "Transport to be used by this service instance for deploying the Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Transport Type", 
      "type": "string"
    }
  }, 
  "title": "Base Instance of a service", 
  "type": "object"
}

BaseSwitchingProfile (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BaseSwitchingProfile", 
  "module_id": "BaseSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BasicAuthenticationScheme (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AuthenticationScheme"+
  }, 
  "id": "BasicAuthenticationScheme", 
  "properties": {
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "basic"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BatchParameter (type) 

{
  "id": "BatchParameter", 
  "module_id": "Common", 
  "properties": {
    "atomic": {
      "default": false, 
      "description": "use this flag if you want transactional atomicity", 
      "required": false, 
      "title": "transactional atomicity for the batch of requests embedded in the batch list", 
      "type": "boolean"
    }
  }, 
  "title": "Options that affect how batch operations are processed", 
  "type": "object"
}

BatchRequest (type) 

{
  "id": "BatchRequest", 
  "module_id": "Common", 
  "properties": {
    "continue_on_error": {
      "default": true, 
      "description": "Flag to decide if we will continue processing subsequent requests in case of current error for atomic = false.", 
      "required": false, 
      "type": "boolean"
    }, 
    "requests": {
      "items": {
        "$ref": "BatchRequestItem"+
      }, 
      "sensitive": true, 
      "type": "array"
    }
  }, 
  "title": "A set of operations to be performed in a single batch", 
  "type": "object"
}

BatchRequestItem (type) 

{
  "id": "BatchRequestItem", 
  "module_id": "Common", 
  "properties": {
    "body": {
      "type": "object"
    }, 
    "method": {
      "description": "http method type", 
      "enum": [
        "GET", 
        "POST", 
        "PUT", 
        "DELETE", 
        "PATCH"
      ], 
      "required": true, 
      "title": "method type(POST/PUT/DELETE/UPDATE)", 
      "type": "string"
    }, 
    "uri": {
      "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", 
      "required": true, 
      "title": "Internal uri of the call", 
      "type": "string"
    }
  }, 
  "title": "A single request within a batch of operations", 
  "type": "object"
}

BatchResponse (type) 

{
  "additionalProperties": false, 
  "id": "BatchResponse", 
  "module_id": "Common", 
  "properties": {
    "has_errors": {
      "description": "Indicates if any of the APIs failed", 
      "title": "errors indicator", 
      "type": "boolean"
    }, 
    "results": {
      "items": {
        "$ref": "BatchResponseItem"+
      }, 
      "required": true, 
      "title": "Bulk list results", 
      "type": "array"
    }, 
    "rolled_back": {
      "description": "Optional flag indicating that all items were rolled back even if succeeded initially", 
      "title": "indicates if all items were rolled back.", 
      "type": "boolean"
    }
  }, 
  "title": "The reponse to a batch operation", 
  "type": "object"
}

BatchResponseItem (type) 

{
  "id": "BatchResponseItem", 
  "module_id": "Common", 
  "properties": {
    "body": {
      "description": "object returned by api", 
      "required": false, 
      "title": "object returned by api", 
      "type": "object"
    }, 
    "code": {
      "description": "http status code", 
      "required": true, 
      "title": "object returned by api", 
      "type": "integer"
    }, 
    "headers": {
      "description": "The headers returned by the API call", 
      "title": "object returned by api", 
      "type": "object"
    }
  }, 
  "title": "A single respose in a list of batched responses", 
  "type": "object"
}

BfdConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BfdConfig", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "declare_dead_multiple": {
      "default": 3, 
      "maximum": 16, 
      "minimum": 2, 
      "required": false, 
      "title": "Number of times a packet is missed before BFD declares the neighbor down.", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable BFD for this LogicalRouter", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "receive_interval": {
      "default": 1000, 
      "description": "the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.", 
      "maximum": 60000, 
      "minimum": 100, 
      "required": false, 
      "title": "Receive interval for heartbeats", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transmit_interval": {
      "default": 1000, 
      "description": "the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.", 
      "maximum": 60000, 
      "minimum": 100, 
      "required": false, 
      "title": "Transmit interval for heartbeats", 
      "type": "integer"
    }
  }, 
  "title": "BFD configuration for LogicalRouter", 
  "type": "object"
}

BfdConfigParameters (type) 

{
  "id": "BfdConfigParameters", 
  "module_id": "Routing", 
  "properties": {
    "declare_dead_multiple": {
      "default": 3, 
      "maximum": 16, 
      "minimum": 2, 
      "required": false, 
      "title": "Number of times a packet is missed before BFD declares the neighbor down.", 
      "type": "integer"
    }, 
    "receive_interval": {
      "default": 1000, 
      "maximum": 60000, 
      "minimum": 300, 
      "required": false, 
      "title": "the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.", 
      "type": "integer"
    }, 
    "transmit_interval": {
      "default": 1000, 
      "maximum": 60000, 
      "minimum": 300, 
      "required": false, 
      "title": "the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.", 
      "type": "integer"
    }
  }, 
  "title": "BFD configuration for the given Peer.", 
  "type": "object"
}

BfdHealthMonitoringProfile (type) 

{
  "extends": {
    "$ref": "TransportZoneProfile"+
  }, 
  "id": "BfdHealthMonitoringProfile", 
  "module_id": "BfdHealthMonitoringProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "BfdHealthMonitoringProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "required": true, 
      "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.", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "probe_interval": {
      "default": 1000, 
      "minimum": 300, 
      "required": false, 
      "title": "The time interval (in millisec) between probe packets for tunnels between transport nodes.", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "BfdHealthMonitoringProfile"
      ], 
      "help_summary": "Possible value is 'BfdHealthMonitoringProfile'", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for BFD health monitoring", 
  "type": "object"
}

BgpConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BgpConfig", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "as_num": {
      "required": false, 
      "title": "4 Byte ASN in ASPLAIN/ASDOT Format", 
      "type": "string"
    }, 
    "as_number": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'as_num' instead.", 
      "maximum": 4294967296, 
      "minimum": 1, 
      "required": false, 
      "title": "Autonomous System Number", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "ecmp": {
      "default": true, 
      "required": false, 
      "title": "Flag to enable ECMP", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable this configuration", 
      "type": "boolean"
    }, 
    "graceful_restart": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable graceful restart", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "route_aggregation": {
      "items": {
        "$ref": "BgpRouteAggregation"+
      }, 
      "maxItems": 1000, 
      "minItems": 0, 
      "required": false, 
      "title": "List of routes to be aggregated", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BgpNeighbor (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BgpNeighbor", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "address_families": {
      "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", 
      "items": {
        "$ref": "BgpNeighborAddressFamily"+
      }, 
      "required": false, 
      "title": "AddressFamily settings for the neighbor", 
      "type": "array"
    }, 
    "bfd_config": {
      "$ref": "BfdConfigParameters"+, 
      "description": "By specifying these paramaters BFD config for this given peer can be overriden | (the globally configured values will not apply for this peer)", 
      "required": false, 
      "title": "BFD Configuration Parameters for the given peer."
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable_bfd": {
      "default": false, 
      "description": "Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.", 
      "required": false, 
      "title": "Enable BFD for this BGP Neighbor", 
      "type": "boolean"
    }, 
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "Flag to enable this BGP Neighbor", 
      "type": "boolean"
    }, 
    "filter_in_ipprefixlist_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please  use 'address_family' instead.", 
      "required": false, 
      "title": "IPPrefix List to be used for IN direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "filter_in_routemap_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'address_family' instead.", 
      "required": false, 
      "title": "RouteMap to be used for IN direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "filter_out_ipprefixlist_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'address_family' instead.", 
      "required": false, 
      "title": "IPPrefixList to be used for OUT direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "filter_out_routemap_id": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'address_family' instead.", 
      "required": false, 
      "title": "RouteMap to be used for OUT direction filter for IPV4_UNICAST address family", 
      "type": "string"
    }, 
    "hold_down_timer": {
      "default": 180, 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Wait period (seconds) before declaring peer dead", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "keep_alive_timer": {
      "default": 60, 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Frequency (seconds) with which keep alive messages are sent to peers", 
      "type": "integer"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "maximum_hop_limit": {
      "default": 1, 
      "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", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum Number of hops allowed to reach BGP neighbor", 
      "type": "int"
    }, 
    "neighbor_address": {
      "$ref": "IPv4Address"+, 
      "required": true, 
      "title": "Neighbor IP Address"
    }, 
    "password": {
      "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", 
      "minLength": 1, 
      "required": false, 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "remote_as": {
      "deprecated": true, 
      "description": "This is a deprecated property, Please use 'remote_as_num' instead.", 
      "maximum": 4294967296, 
      "minimum": 1, 
      "required": false, 
      "title": "Autonomous System Number of the neighbor", 
      "type": "integer"
    }, 
    "remote_as_num": {
      "required": false, 
      "title": "4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "source_address": {
      "$ref": "IPv4Address"+, 
      "deprecated": true, 
      "description": "Deprecated - do not provide a value for this field. Use source_addresses instead.", 
      "required": false, 
      "title": "Logical Router Uplink IP Address"
    }, 
    "source_addresses": {
      "description": "BGP neighborship will be formed from all these source addresses to this neighbour.", 
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 8, 
      "required": false, 
      "title": "Array of Logical Router Uplink IP Addresses", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

BgpNeighborAddressFamily (type) 

{
  "id": "BgpNeighborAddressFamily", 
  "module_id": "Routing", 
  "properties": {
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "Enable this address family", 
      "type": "boolean"
    }, 
    "in_filter_ipprefixlist_id": {
      "required": false, 
      "title": "Id of the IPPrefix List to be used for IN direction filter", 
      "type": "string"
    }, 
    "in_filter_routemap_id": {
      "required": false, 
      "title": "Id of the RouteMap to be used for IN direction filter", 
      "type": "string"
    }, 
    "out_filter_ipprefixlist_id": {
      "required": false, 
      "title": "Id of the IPPrefixList to be used for OUT direction filter", 
      "type": "string"
    }, 
    "out_filter_routemap_id": {
      "required": false, 
      "title": "Id of the RouteMap to be used for OUT direction filter", 
      "type": "string"
    }, 
    "type": {
      "$ref": "AddressFamilyType"+, 
      "required": true, 
      "title": "Address family type"
    }
  }, 
  "type": "object"
}

BgpNeighborListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "BgpNeighborListResult", 
  "module_id": "Routing", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BgpNeighbor"+
      }, 
      "required": true, 
      "title": "Paginated list of bgp neighbors", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpNeighborStatus (type) 

{
  "id": "BgpNeighborStatus", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "announced_capabilities": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "BGP capabilities sent to BGP neighbor.", 
      "type": "array"
    }, 
    "connection_drop_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of connection drop", 
      "type": "integer"
    }, 
    "connection_state": {
      "enum": [
        "INVALID", 
        "IDLE", 
        "CONNECT", 
        "ACTIVE", 
        "OPEN_SENT", 
        "OPEN_CONFIRM", 
        "ESTABLISHED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Current state of the BGP session.", 
      "type": "string"
    }, 
    "established_connection_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of connections established", 
      "type": "integer"
    }, 
    "graceful_restart": {
      "readonly": true, 
      "required": false, 
      "title": "Indicate current state of graceful restart where graceful_restart = true indicate graceful restart is enabled and graceful_restart = false indicate graceful restart is disabled.", 
      "type": "boolean"
    }, 
    "hold_time": {
      "readonly": true, 
      "required": false, 
      "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.", 
      "type": "integer"
    }, 
    "keep_alive_interval": {
      "readonly": true, 
      "required": false, 
      "title": "Time in ms to wait for HELLO packet from BGP peer", 
      "type": "integer"
    }, 
    "local_port": {
      "maximum": 65535, 
      "minimum": 1, 
      "readonly": true, 
      "required": false, 
      "title": "TCP port number of Local BGP connection", 
      "type": "integer"
    }, 
    "lr_component_id": {
      "readonly": true, 
      "required": true, 
      "title": "Logical router component(Service Router/Distributed Router) id", 
      "type": "string"
    }, 
    "messages_received": {
      "readonly": true, 
      "required": false, 
      "title": "Count of messages received from the neighbor", 
      "type": "integer"
    }, 
    "messages_sent": {
      "readonly": true, 
      "required": false, 
      "title": "Count of messages sent to the neighbor", 
      "type": "integer"
    }, 
    "negotiated_capability": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "BGP capabilities negotiated with BGP neighbor.", 
      "type": "array"
    }, 
    "neighbor_address": {
      "$ref": "IPAddress"+, 
      "readonly": true, 
      "required": false, 
      "title": "The IP of the BGP neighbor"
    }, 
    "neighbor_router_id": {
      "$ref": "IPAddress"+, 
      "additionalProperties": false, 
      "readonly": true, 
      "required": false, 
      "title": "Router ID of the BGP neighbor."
    }, 
    "remote_as_number": {
      "readonly": true, 
      "required": false, 
      "title": "AS number of the BGP neighbor", 
      "type": "string"
    }, 
    "remote_port": {
      "maximum": 65535, 
      "minimum": 1, 
      "readonly": true, 
      "required": false, 
      "title": "TCP port number of remote BGP Connection", 
      "type": "integer"
    }, 
    "source_address": {
      "$ref": "IPAddress"+, 
      "readonly": true, 
      "required": false, 
      "title": "The Ip address of logical port"
    }, 
    "time_since_established": {
      "readonly": true, 
      "required": false, 
      "title": "Time(in milliseconds) since connection was established.", 
      "type": "integer"
    }, 
    "total_in_prefix_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of in prefixes", 
      "type": "integer"
    }, 
    "total_out_prefix_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of out prefixes", 
      "type": "integer"
    }, 
    "transport_node": {
      "$ref": "ResourceReference"+, 
      "readonly": true, 
      "required": false, 
      "title": "Transport node id and name"
    }
  }, 
  "type": "object"
}

BgpNeighborsStatusListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "BgpNeighborsStatusListResult", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated, unset if data source has never updated the data.", 
      "readonly": true, 
      "title": "Timestamp indicating last update time of data"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "logical_router_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the logical router", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "additionalProperties": false, 
      "items": {
        "$ref": "BgpNeighborStatus"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Status of BGP neighbors of the logical router", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

BgpRouteAggregation (type) 

{
  "additionalProperties": false, 
  "id": "BgpRouteAggregation", 
  "module_id": "Routing", 
  "properties": {
    "prefix": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": true, 
      "title": "cidr of the aggregate address"
    }, 
    "summary_only": {
      "default": true, 
      "required": false, 
      "title": "Flag to send only summarized route", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

BlackholeAction (type) 

{
  "additionalProperties": false, 
  "enum": [
    "DISCARD"
  ], 
  "id": "BlackholeAction", 
  "module_id": "Routing", 
  "title": "Action to be taken on matching packets for NULL routes. For action is DISCARD, matching packets are dropped rather than forwarded.", 
  "type": "string"
}

BpduFilter (type) 

{
  "id": "BpduFilter", 
  "module_id": "SwitchSecuritySwitchingProfile", 
  "properties": {
    "enabled": {
      "readonly": false, 
      "required": true, 
      "title": "Indicates whether BPDU filter is enabled", 
      "type": "boolean"
    }, 
    "white_list": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 32, 
      "minItems": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering", 
      "type": "array"
    }
  }, 
  "title": "BPDU filter configuration", 
  "type": "object"
}

BridgeCluster (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BridgeCluster", 
  "module_id": "BridgeCluster", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bridge_nodes": {
      "items": {
        "$ref": "BridgeClusterNode"+
      }, 
      "maxItems": 2, 
      "required": true, 
      "title": "Nodes used in bridging", 
      "type": "array"
    }, 
    "cluster_profile_bindings": {
      "items": {
        "$ref": "ClusterProfileTypeIdEntry"+
      }, 
      "required": false, 
      "title": "Bridge cluster profile bindings", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Bridge Cluster", 
  "type": "object"
}

BridgeClusterListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "BridgeClusterListResult", 
  "module_id": "BridgeCluster", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BridgeCluster"+
      }, 
      "minItems": 0, 
      "readonly": true, 
      "required": true, 
      "title": "BridgeCluster Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Bridge cluster queries result", 
  "type": "object"
}

BridgeClusterNode (type) 

{
  "id": "BridgeClusterNode", 
  "module_id": "BridgeCluster", 
  "properties": {
    "ha_mac": {
      "$ref": "MACAddress"+, 
      "readonly": true, 
      "required": false, 
      "title": "MAC address used for HA protocol"
    }, 
    "transport_node_id": {
      "maxLength": 36, 
      "required": true, 
      "title": "UUID of the transport node", 
      "type": "string"
    }
  }, 
  "title": "Bridge transport node", 
  "type": "object"
}

BridgeEndpoint (type) 

{
  "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", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BridgeEndpoint", 
  "module_id": "BridgeEndpoint", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bridge_cluster_id": {
      "description": "This field will not be used if an edge cluster is being used for the\nbridge endpoint\n", 
      "maxLength": 36, 
      "required": false, 
      "title": "UUID of the bridge cluster for this bridge endpoint", 
      "type": "string"
    }, 
    "bridge_endpoint_profile_id": {
      "description": "This field will not be used if a bridge cluster is being used for the\nbridge endpoint\n", 
      "required": false, 
      "title": "Bridge endpoint profile used by the edge cluster", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "ha_enable": {
      "default": true, 
      "description": "This field will not be used if an edge cluster is being used for the\nbridge endpoint\n", 
      "required": false, 
      "title": "Controls the enabling of HA on the VLAN for this endpoint", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vlan": {
      "$ref": "VlanID"+, 
      "required": true
    }, 
    "vlan_transport_zone_id": {
      "description": "This field will not be used if a bridge cluster is being used for the\nbridge endpoint\n", 
      "required": false, 
      "title": "VLAN transport zone id by the edge cluster", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint", 
  "type": "object"
}

BridgeEndpointListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "BridgeEndpointListResult", 
  "module_id": "BridgeEndpoint", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BridgeEndpoint"+
      }, 
      "minItems": 0, 
      "readonly": true, 
      "required": true, 
      "title": "BridgeEndpoint Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint queries result", 
  "type": "object"
}

BridgeEndpointProfile (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "BridgeEndpointProfile", 
  "module_id": "BridgeEndpointProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_id": {
      "maxLength": 36, 
      "required": true, 
      "title": "UUID of the edge cluster for this bridge endpoint", 
      "type": "string"
    }, 
    "edge_cluster_member_indexes": {
      "description": "First index will be used as the preferred member", 
      "items": {
        "type": "int"
      }, 
      "required": false, 
      "title": "Indexes of the member hosts of the edge bridge cluster", 
      "type": "array"
    }, 
    "failover_mode": {
      "default": "PREEMPTIVE", 
      "description": "Faileover mode can be preemmptive or non-preemptive", 
      "enum": [
        "PREEMPTIVE", 
        "NON_PREEMPTIVE"
      ], 
      "required": false, 
      "title": "Failover mode for the edge bridge cluster", 
      "type": "string"
    }, 
    "high_availability_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "High avaialability mode can be active-active or active-standby", 
      "enum": [
        "ACTIVE_STANDBY"
      ], 
      "required": false, 
      "title": "High availability mode for the edge bridge cluster", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Bridge Endpoint Profile", 
  "type": "object"
}

BridgeEndpointProfileListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "BridgeEndpointProfileListResult", 
  "module_id": "BridgeEndpointProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BridgeEndpointProfile"+
      }, 
      "minItems": 0, 
      "readonly": true, 
      "required": true, 
      "title": "BridgeEndpointProfile Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint Profile queries result", 
  "type": "object"
}

BridgeEndpointProfileRequestParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "BridgeEndpointProfileRequestParameters", 
  "module_id": "BridgeEndpointProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "edge_cluster_id": {
      "required": false, 
      "title": "Edge Cluster Identifier", 
      "type": "string"
    }, 
    "failover_mode": {
      "required": false, 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint Profile request parameters", 
  "type": "object"
}

BridgeEndpointRequestParameters (type) 

{
  "description": "When querying for bridge endpoints on a bridge cluster, following\nparameters can be used: bridge_cluster_id and logical_switch_id. When\nquerying for bridge endpoints on an edge cluster, following parameters\ncan be used: bridge_endpoint_profile_id, vlan_transport_zone_id and\nlogical_switch_id. When multiple parameters are provided they will be\nanded together. if bridge_cluster_id is used along with\nbridge_endpoint_profile_id or vlan_transport_zone_id an error will be\nthrown.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "BridgeEndpointRequestParameters", 
  "module_id": "BridgeEndpoint", 
  "properties": {
    "bridge_cluster_id": {
      "description": "If provided, only bridge endpoints associated with the given bridge\ncluster will be returned.\n", 
      "required": false, 
      "title": "Bridge Cluster Identifier", 
      "type": "string"
    }, 
    "bridge_endpoint_profile_id": {
      "description": "If provided, only bridge endpoints associated with the given bridge\nendpoint profile will be returned.\n", 
      "required": false, 
      "title": "Bridge endpoint profile used by the edge cluster", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "description": "If provided, only bridge endpoints associated with the given logical\nswitch will be returned.\n", 
      "required": false, 
      "title": "Logical Switch Identifier", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vlan_transport_zone_id": {
      "description": "If provided, only bridge endpoints associated with the given transport\nzone will be returned.\n", 
      "required": false, 
      "title": "VLAN transport zone id used by the edge cluster", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint request parameters", 
  "type": "object"
}

BridgeHighAvailabilityClusterProfile (type) 

{
  "extends": {
    "$ref": "ClusterProfile"+
  }, 
  "id": "BridgeHighAvailabilityClusterProfile", 
  "module_id": "BridgeHighAvailabilityClusterProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "BridgeHighAvailabilityClusterProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bfd_probe_interval": {
      "default": 1000, 
      "maximum": 60000, 
      "minimum": 300, 
      "required": false, 
      "title": "the time interval (in millisec) between probe packets for heartbeat purpose", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable": {
      "default": true, 
      "required": false, 
      "title": "whether the heartbeat is enabled", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType"+, 
      "help_summary": "The cluster profile type.", 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for BFD HA cluster setting", 
  "type": "object"
}

ByodServiceInstance (type) 

{
  "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.", 
  "extends": {
    "$ref": "BaseServiceInstance"+
  }, 
  "id": "ByodServiceInstance", 
  "module_id": "ServiceInsertionCommonTypes", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ByodServiceInstance"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "on_failure_policy": {
      "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.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "required": false, 
      "title": "On Failure Policy", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ServiceInstanceResourceType"+, 
      "required": true
    }, 
    "service_id": {
      "description": "The Service to which the service instance is associated.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "description": "Transport to be used by this service instance for deploying the Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Transport Type", 
      "type": "string"
    }
  }, 
  "title": "Custom Instance of a service", 
  "type": "object"
}

CCPUpgradeStatus (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus"+
  }, 
  "id": "CCPUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }
  }, 
  "title": "Status of CCP upgrade", 
  "type": "object"
}

CapacityUsage (type) 

{
  "description": "usage of each capacity type ex. vm, cpu", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "CapacityUsage", 
  "module_id": "License", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "capacity_type": {
      "readonly": true, 
      "title": "type of the capacity field", 
      "type": "string"
    }, 
    "usage_count": {
      "readonly": true, 
      "title": "count of number of items of capacity_type", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

Certificate (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "Certificate", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "details": {
      "description": "list of X509Certificates", 
      "items": {
        "$ref": "X509Certificate"+
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "pem encoded certificate data", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "used_by": {
      "description": "list of node IDs with services, that are using this certificate", 
      "items": {
        "$ref": "NodeIdServicesMap"+
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

CertificateId (type) 

{
  "additionalProperties": false, 
  "id": "CertificateId", 
  "properties": {
    "certificate_id": {
      "readonly": true, 
      "required": true, 
      "title": "Certificate ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CertificateList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "CertificateList", 
  "module_id": "CertificateManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Certificate list", 
      "items": {
        "$ref": "Certificate"+
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Certificate queries result", 
  "type": "object"
}

CidrBlock (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about IPv4 CIDR block.", 
  "format": "ipv4_cidr_block", 
  "id": "CidrBlock", 
  "module_id": "CloudServiceManager", 
  "title": "IPv4 CIDR Block", 
  "type": "string"
}

CipherSuite (type) 

{
  "additionalProperties": false, 
  "id": "CipherSuite", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "Enable status for this cipher suite", 
      "type": "boolean"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the TLS cipher suite", 
      "type": "string"
    }
  }, 
  "title": "HTTP cipher suite", 
  "type": "object"
}

ClasslessStaticRoute (type) 

{
  "additionalProperties": false, 
  "id": "ClasslessStaticRoute", 
  "module_id": "Dhcp", 
  "properties": {
    "network": {
      "$ref": "IPElement"+, 
      "required": true, 
      "title": "destination in cidr"
    }, 
    "next_hop": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "router"
    }
  }, 
  "type": "object"
}

ClientAuthType (type) 

{
  "additionalProperties": false, 
  "description": "Client authentication could be REQUIRED or IGNORE.\nREQUIRED means that client is required to present its\ncertificate to the server for authentication. To be accepted, client\ncertificate must be signed by one of the trusted Certificate\nAuthorities (CAs), also referred to as root CAs, whose self signed\ncertificates are specified in the same client SSL profile binding.\nIGNORE means that client certificate would be ignored.\n", 
  "enum": [
    "REQUIRED", 
    "IGNORE"
  ], 
  "id": "ClientAuthType", 
  "module_id": "LoadBalancer", 
  "title": "client authentication mode", 
  "type": "string"
}

ClientSslProfileBinding (type) 

{
  "additionalProperties": false, 
  "id": "ClientSslProfileBinding", 
  "module_id": "LoadBalancer", 
  "properties": {
    "certificate_chain_depth": {
      "default": 3, 
      "description": "authentication depth is used to set the verification depth in the client\ncertificates chain.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the maximum traversal depth of client certificate chain", 
      "type": "integer"
    }, 
    "client_auth": {
      "$ref": "ClientAuthType"+, 
      "default": "IGNORE", 
      "required": false, 
      "title": "client authentication mode"
    }, 
    "client_auth_ca_ids": {
      "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", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CA identifier list to verify client certificate", 
      "type": "array"
    }, 
    "client_auth_crl_ids": {
      "description": "A Certificate Revocation List (CRL) can be specified in the client-side\nSSL profile binding to disallow compromised client certificates.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CRL identifier list to verify client certificate", 
      "type": "array"
    }, 
    "default_certificate_id": {
      "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", 
      "required": true, 
      "title": "default service certificate identifier", 
      "type": "string"
    }, 
    "sni_certificate_ids": {
      "description": "Client-side SSL profile binding allows multiple certificates, for\ndifferent hostnames, to be bound to the same virtual server.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "SNI certificate identifier list", 
      "type": "array"
    }, 
    "ssl_profile_id": {
      "description": "Client SSL profile defines reusable, application-independent client side\nSSL properties.\n", 
      "required": false, 
      "title": "client SSL profile identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClientTypeCollectionConfiguration (type) 

{
  "id": "ClientTypeCollectionConfiguration", 
  "module_id": "AggSvcDataCollectionConfig", 
  "properties": {
    "client_type": {
      "description": "The client type for which this data collection frequency setting applies", 
      "enum": [
        "HYPERVISOR", 
        "EDGE", 
        "CONTROL_PLANE", 
        "CONTROL_PLANE_PLATFORM", 
        "MANAGEMENT_PLANE", 
        "MANAGEMENT_PLANE_PLATFORM"
      ], 
      "required": true, 
      "title": "Client Type", 
      "type": "string"
    }, 
    "data_type_configurations": {
      "description": "The set of data collection type configurations, one for each data collection type", 
      "items": {
        "$ref": "DataTypeCollectionConfiguration"+
      }, 
      "required": true, 
      "title": "Data type configurations", 
      "type": "array"
    }
  }, 
  "title": "HPM client data collection configuration", 
  "type": "object"
}

CloudAccount (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about a cloud account like cloud type and insatnce\nstatistics.\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "CloudAccount", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "auth_users": {
      "description": "List of authorized users.", 
      "items": {
        "$ref": "CloudUserInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Authrized Users", 
      "type": "array"
    }, 
    "cloud_tags_enabled": {
      "default": true, 
      "description": "Boolean flag to enable or disable cloud tags discovery. The discovered\ncloud tags can be used to define security group membership.\n", 
      "hidden": true, 
      "readonly": false, 
      "required": false, 
      "title": "Boolean flag to enable or disable cloud tags discovery", 
      "type": "boolean"
    }, 
    "cloud_type": {
      "decription": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats"+, 
      "description": "Stores statistics of the number of managed, unmanaged and error virtual\nmachines.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the cloud account.", 
      "readonly": true, 
      "required": false, 
      "title": "Tenant ID", 
      "type": "string"
    }
  }, 
  "title": "Cloud Account", 
  "type": "object"
}

CloudAccountStatus (type) 

{
  "additionalProperties": false, 
  "description": "Stores the status of cloud account like credentials validity status and\ninventory synchronization status.\n", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "CloudAccountStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "credentials_status": {
      "description": "Status of the cloud account credentials synced at the auto interval.\n", 
      "enum": [
        "VALID", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Credentials Status", 
      "type": "string"
    }, 
    "inventory_sync_status": {
      "description": "Status of inventory synchronization process.", 
      "enum": [
        "SYNCED", 
        "IN_PROGRESS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Inventory Synchronization Status", 
      "type": "string"
    }
  }, 
  "title": "Cloud Account status", 
  "type": "object"
}

CloudSecurityGroup (type) 

{
  "additionalProperties": false, 
  "description": "Stores cloud security group information.\n", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "CloudSecurityGroup", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "security_group_id": {
      "description": "ID of the cloud security group.\n", 
      "required": false, 
      "title": "Security Group ID", 
      "type": "string"
    }, 
    "security_group_name": {
      "description": "Name of the cloud security group.\n", 
      "required": false, 
      "title": "Security Group Name", 
      "type": "string"
    }
  }, 
  "title": "Cloud Security Group", 
  "type": "object"
}

CloudTag (type) 

{
  "additionalProperties": false, 
  "description": "Stores the key-value pair of cloud tag", 
  "id": "CloudTag", 
  "module_id": "CloudVirtualMachineInformation", 
  "properties": {
    "key": {
      "description": "Key of the tag", 
      "readonly": true, 
      "required": false, 
      "title": "Tag key", 
      "type": "string"
    }, 
    "value": {
      "description": "Value of the tag", 
      "readonly": true, 
      "required": false, 
      "title": "Tag value", 
      "type": "string"
    }
  }, 
  "title": "Cloud Tag", 
  "type": "object"
}

CloudTypeInfo (type) 

{
  "additionalProperties": false, 
  "id": "CloudTypeInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "cloud_type": {
      "description": "Name of the cloud vendor.", 
      "readonly": true, 
      "required": false, 
      "title": "Cloud Type", 
      "type": "string"
    }
  }, 
  "title": "Cloud Type information", 
  "type": "object"
}

CloudUserInfo (type) 

{
  "additionalProperties": false, 
  "id": "CloudUserInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Display name of the user", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the user", 
      "type": "string"
    }
  }, 
  "title": "User information", 
  "type": "object"
}

CloudVirtualMachine (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about a Virtual Machine\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "CloudVirtualMachine", 
  "module_id": "CloudVirtualMachineInformation", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "agent_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "NO_AGENT"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Agent Status", 
      "type": "string"
    }, 
    "agent_version": {
      "readonly": true, 
      "required": false, 
      "title": "Agent version details", 
      "type": "string"
    }, 
    "associated_account_ids": {
      "description": "Array of associated cloud account IDs.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Associated Cloud Account IDs", 
      "type": "array"
    }, 
    "cloud_tags": {
      "items": {
        "$ref": "CloudTag"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cloud tags for the virtual machine", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "error_messages": {
      "description": "List of error messages identified. Returns only error messages\nidentified in the last 1 hour.\n", 
      "items": {
        "$ref": "ComputeInstanceErrorMessage"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of error messages", 
      "type": "array"
    }, 
    "gateway_ha_index": {
      "description": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "required": false, 
      "title": "Gateway HA Index", 
      "type": "integer"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway Status", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_gateway": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this VM is a gateway node", 
      "type": "boolean"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this VM is an active gateway node", 
      "type": "boolean"
    }, 
    "logical_switch_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch display name", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "managed_by_nsx": {
      "readonly": true, 
      "required": true, 
      "title": "Indicate if vm is managed by NSX or not", 
      "type": "boolean"
    }, 
    "nsx_ip": {
      "readonly": true, 
      "required": false, 
      "title": "IP address provided by NSX", 
      "type": "string"
    }, 
    "os_details": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system details", 
      "type": "string"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "Operating system of the virtual machine", 
      "type": "string"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Indicates the quarantine state of the VM.\nQUARANTINED - This state implies VM is moved to quarantine security\ngroup because some threat has been detected.\nNOT_QUARANTINED - This state implies no quarantine action has been\ntaken.\nUNKNOWN - This state implies either quarantine policy is disabled or\nquarantine information is not available.\nOVERRIDDEN - This state implies VM is associated with vm_override_sg\nwhich overrides any action based on threat detection.\n", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource. Possible values are in the form of\nVirtualMachine prefixed by cloud name. For example,\nAwsVirtualMachine or AzureVirtualMachine.\n", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "threat_state": {
      "description": "Indicates the threat state of the VM.\nNORMAL - This state implies no threat has been detected and VM is\nfunctioning as expected.\nTHREAT - This state implies quarantine enabling threat has been\ndetected.\nINVALID - This state implies either VM is unmanaged or threat related\ninformation is not available.\n", 
      "enum": [
        "NORMAL", 
        "THREAT", 
        "INVALID"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Threat State", 
      "type": "string"
    }, 
    "vm_extension_execution_status": {
      "description": "UNKNOWN - This is the default state. Indicates no information available\n          regarding extension execution. This can potentially occur for\n          a VM when agent is installed out of band or if\n          cloud_agent_automated_install_enabled flag is enabled for the\n          VNET/VPC which already has managed VMs.\nSUCCESSFUL - Indicates VM extension script execution was successful.\n          This does not necessarily mean agent installation was\n          successful.\nFAILED - Indicates VM extension script execution failed.\n", 
      "readonly": true, 
      "required": false, 
      "title": "VM extension script execution status", 
      "type": "string"
    }
  }, 
  "title": "Cloud Virtual Machine Information", 
  "type": "object"
}

CloudVirtualMachinesListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "A set of optional filter parameters to list cloud virtual machines", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "CloudVirtualMachinesListRequestParameters", 
  "module_id": "CloudVirtualMachineInformation", 
  "properties": {
    "account_id": {
      "description": "Optional identifier for account based on which virtual machines are to\nbe filtered\n", 
      "required": false, 
      "title": "Account ID", 
      "type": "string"
    }, 
    "cloud_type": {
      "description": "Optional identifier for cloud provider based on which Virtual Machines\nare to be filtered\n", 
      "enum": [
        "AWS", 
        "AZURE"
      ], 
      "required": false, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "instance_id": {
      "description": "Optional identifier for virtual machine based on which the list can be\nfiltered\n", 
      "required": false, 
      "title": "Instance ID", 
      "type": "string"
    }, 
    "is_gateway": {
      "description": "Optional identifier based on which only gateway Virtual Machines can be\nfiltered\n", 
      "required": false, 
      "title": "Is the VM a gateway node?", 
      "type": "boolean"
    }, 
    "logical_switch_id": {
      "description": "Optional identifier for logical switch based on which Aws Virtual\nMachines are to be filtered\n", 
      "required": false, 
      "title": "Logical Switch ID", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "public_ip": {
      "description": "Optional identifier for public IP based on which Virtual Machines are\nto be filtered\n", 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "quarantine_state": {
      "description": "Identifier for quarantine state based on which Virtual Machines are to\nbe filtered.\nQUARANTINED - This state implies VM is moved to quarantine security\ngroup because some threat has been detected.\nNOT_QUARANTINED - This state implies no quarantine action has been\ntaken.\nUNKNOWN - This state implies either quarantine policy is disabled or\nquarantine information is not available.\nOVERRIDDEN - This state implies VM is associated with vm_override_sg\nwhich overrides any action based on threat detection.\n", 
      "enum": [
        "QUARANTINED", 
        "NOT_QUARANTINED", 
        "UNKNOWN", 
        "OVERRIDDEN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Quarantine State", 
      "type": "string"
    }, 
    "region_id": {
      "description": "Optional identifier for AWS or Azure region based on which Virtual\nMachines are to be filtered\n", 
      "required": false, 
      "title": "Region ID", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Optional identifier for listing virtual machines of a particular cloud\nprovider. Possible values are in the form of VirtualMachine prefixed by\ncloud name. For example, AwsVirtualMachine or AzureVirtualMachine.\n", 
      "enum": [
        "AwsVirtualMachine", 
        "AzureVirtualMachine"
      ], 
      "required": false, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vnet_id": {
      "description": "Optional identifier for Azure virtual network based on which Azure\nVirtual Machines are to be filtered. It consists of resourceGuid of Azure Vnet.\n", 
      "required": false, 
      "title": "Azure virtual network ID", 
      "type": "string"
    }, 
    "vpc_id": {
      "description": "Optional identifier for AWS VPC based on which Virtual Machines are to\nbe filtered\n", 
      "required": false, 
      "title": "AWS VPC ID", 
      "type": "string"
    }
  }, 
  "title": "Cloud Virtual Machines List Request Parameters", 
  "type": "object"
}

CloudVirtualMachinesListResult (type) 

{
  "additionalProperties": false, 
  "description": "Stores a list of cloud virtual machines", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "CloudVirtualMachinesListResult", 
  "module_id": "CloudVirtualMachineInformation", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of cloud virtual machines", 
      "items": {
        "$ref": "CloudVirtualMachine"+
      }, 
      "required": false, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cloud Virtual Machines List Result", 
  "type": "object"
}

ClusterBackupInfo (type) 

{
  "additionalProperties": false, 
  "id": "ClusterBackupInfo", 
  "module_id": "ClusterRestore", 
  "properties": {
    "ip_address": {
      "$ref": "IPAddress"+, 
      "readonly": true, 
      "required": true, 
      "title": "IP address of the node from which the backup was taken"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "ID of the node from which the backup was taken", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": true, 
      "title": "timestamp of the cluster backup file"
    }
  }, 
  "title": "Cluster backup details", 
  "type": "object"
}

ClusterBackupInfoListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ClusterBackupInfoListResult", 
  "module_id": "ClusterRestore", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterBackupInfo"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of timestamps of backed-up cluster files", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "ClusterConfig", 
  "module_id": "ClusterManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cluster_id": {
      "readonly": true, 
      "title": "Unique identifier of this cluster", 
      "type": "string"
    }, 
    "control_cluster_changes_allowed": {
      "required": true, 
      "title": "True if control cluster nodes may be added or removed", 
      "type": "boolean"
    }, 
    "mgmt_cluster_changes_allowed": {
      "required": true, 
      "title": "True if management cluster nodes may be added or removed", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ClusterGroupMemberStatus (type) 

{
  "additionalProperties": false, 
  "description": "This type contains the attributes and status of a group member.", 
  "id": "ClusterGroupMemberStatus", 
  "module_id": "Cluster", 
  "properties": {
    "member_name": {
      "format": "ip", 
      "readonly": true, 
      "title": "Name of the group member", 
      "type": "string"
    }, 
    "member_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "Status of the group member", 
      "type": "string"
    }, 
    "member_uuid": {
      "readonly": true, 
      "title": "UUID of the group member", 
      "type": "string"
    }
  }, 
  "title": "Status of a group member", 
  "type": "object"
}

ClusterGroupServiceLeader (type) 

{
  "additionalProperties": false, 
  "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.", 
  "id": "ClusterGroupServiceLeader", 
  "module_id": "Cluster", 
  "properties": {
    "leader_uuid": {
      "readonly": true, 
      "title": "Member UUID of the leader", 
      "type": "string"
    }, 
    "lease_version": {
      "readonly": true, 
      "title": "Number of times the lease has been renewed", 
      "type": "integer"
    }, 
    "service_name": {
      "readonly": true, 
      "title": "Name of the service", 
      "type": "string"
    }
  }, 
  "title": "Leader for a service of the group", 
  "type": "object"
}

ClusterGroupStatus (type) 

{
  "additionalProperties": false, 
  "description": "This type contains the attributes and status of a group.", 
  "id": "ClusterGroupStatus", 
  "module_id": "Cluster", 
  "properties": {
    "group_id": {
      "readonly": true, 
      "title": "UUID of the group", 
      "type": "string"
    }, 
    "group_status": {
      "enum": [
        "STABLE", 
        "DEGRADED", 
        "UNSTABLE", 
        "UNAVAILABLE"
      ], 
      "readonly": true, 
      "title": "Group status", 
      "type": "string"
    }, 
    "group_type": {
      "enum": [
        "MANAGER", 
        "CONTROLLER", 
        "POLICY", 
        "HTTP"
      ], 
      "readonly": true, 
      "title": "Type of the group", 
      "type": "string"
    }, 
    "leaders": {
      "items": {
        "$ref": "ClusterGroupServiceLeader"+
      }, 
      "readonly": true, 
      "title": "Array of group leaders and their attributes", 
      "type": "array"
    }, 
    "members": {
      "items": {
        "$ref": "ClusterGroupMemberStatus"+
      }, 
      "readonly": true, 
      "title": "Array of group members and their statuses", 
      "type": "array"
    }
  }, 
  "title": "Status of a group", 
  "type": "object"
}

ClusterInitializationNodeInfo (type) 

{
  "additionalProperties": false, 
  "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).", 
  "id": "ClusterInitializationNodeInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "disk_store_id": {
      "readonly": true, 
      "required": false, 
      "title": "The (internal) disk-store ID of the member", 
      "type": "string"
    }, 
    "host_address": {
      "readonly": true, 
      "title": "The IP address (or domain name) of the cluster node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterNodeConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ClusterNodeConfig", 
  "module_id": "ClusterManagement", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "appliance_mgmt_listen_addr": {
      "readonly": true, 
      "title": "The IP and port for the appliance management API service on this node", 
      "type": "string"
    }, 
    "controller_role": {
      "$ref": "ControllerClusterRoleConfig"+, 
      "required": false
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "title": "Internal identifier provided by the node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "manager_role": {
      "$ref": "ManagementClusterRoleConfig"+, 
      "required": false
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ClusterNodeConfigListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ClusterNodeConfigListResult", 
  "module_id": "ClusterManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterNodeConfig"+
      }, 
      "required": true, 
      "title": "Cluster node configuration results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterNodeRole (type) 

{
  "description": "Enumerates the types of cluster nodes for which VM auto-deployment is\ncurrently supported.\n", 
  "enum": [
    "CONTROLLER", 
    "MANAGER"
  ], 
  "id": "ClusterNodeRole", 
  "module_id": "ClusterNodeVMDeployment", 
  "title": "Cluster node role", 
  "type": "string"
}

ClusterNodeStatus (type) 

{
  "additionalProperties": false, 
  "id": "ClusterNodeStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "control_cluster_status": {
      "$ref": "ControlClusterNodeStatus"+, 
      "readonly": true, 
      "title": "Clustering status for control plane functions on this node"
    }, 
    "mgmt_cluster_status": {
      "$ref": "ManagementClusterNodeStatus"+, 
      "readonly": true, 
      "title": "Clustering status for management plane functions on this node"
    }, 
    "system_status": {
      "$ref": "NodeStatusProperties"+, 
      "readonly": true, 
      "title": "Node status properties"
    }, 
    "version": {
      "readonly": true, 
      "title": "Software version running on node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterNodeVMDeploymentConfig (type) 

{
  "description": "Contains info used to configure the VM on deployment", 
  "id": "ClusterNodeVMDeploymentConfig", 
  "module_id": "ClusterNodeVMDeployment", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "placement_type"
  }, 
  "properties": {
    "placement_type": {
      "description": "Specifies the config for the platform through which to deploy the VM\n", 
      "enum": [
        "VsphereClusterNodeVMDeploymentConfig"
      ], 
      "required": true, 
      "title": "Type of deployment", 
      "type": "string"
    }
  }, 
  "title": "Configuration for deploying cluster node VM", 
  "type": "object"
}

ClusterNodeVMDeploymentRequest (type) 

{
  "additionalProperties": false, 
  "description": "Contains the deployment information for a cluster node VM soon to be\ndeployed or already deployed by the Manager\n", 
  "id": "ClusterNodeVMDeploymentRequest", 
  "module_id": "ClusterNodeVMDeployment", 
  "properties": {
    "deployment_config": {
      "$ref": "ClusterNodeVMDeploymentConfig"+, 
      "description": "Info needed to configure a cluster node VM at deployment for a\nspecific platform.\nMay require different parameters depending on the method used to deploy\nthe VM.\n", 
      "required": true, 
      "title": "Deployment config for cluster node VM"
    }, 
    "form_factor": {
      "$ref": "ClusterNodeVMFormFactor"+, 
      "default": "MEDIUM", 
      "description": "Specifies the desired \"size\" of the VM\nNote: MEDIUM is currently the only supported size for controllers.\n", 
      "required": false, 
      "title": "Form factor for cluster node VMs"
    }, 
    "roles": {
      "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.\n", 
      "items": {
        "$ref": "ClusterNodeRole"+
      }, 
      "required": true, 
      "title": "Cluster node roles of the VM", 
      "type": "array"
    }, 
    "user_settings": {
      "$ref": "NodeUserSettings"+, 
      "description": "Username and password settings for the cluster node VM.\nNote: These settings will be honored only during VM deployment.\nPost-deployment, CLI must be used for changing the user settings and\nchanges to these parameters will not have any effect.\n", 
      "required": true, 
      "sensitive": true, 
      "title": "User settings for the VM"
    }, 
    "vm_id": {
      "description": "ID of the VM maintained internally and used to recognize it.\nNote: This is automatically generated and cannot be modified.\n", 
      "readonly": true, 
      "required": false, 
      "title": "ID of VM used to recognize it", 
      "type": "string"
    }
  }, 
  "title": "Info for an auto-deployment request", 
  "type": "object"
}

ClusterNodeVMDeploymentRequestList (type) 

{
  "additionalProperties": false, 
  "description": "List of ClusterNodeVMDeploymentRequests", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ClusterNodeVMDeploymentRequestList", 
  "module_id": "ClusterNodeVMDeployment", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of existing ClusterNodeVMDeploymentRequests\n", 
      "items": {
        "$ref": "ClusterNodeVMDeploymentRequest"+
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ClusterNodeVMDeploymentRequest list", 
  "type": "object"
}

ClusterNodeVMFormFactor (type) 

{
  "description": "Specifies the desired \"size\" of the VM. Affects number of virtual CPUs\nand/or memory size given to the new cluster node VM.\nIMPORTANT: MEDIUM is currently the only supported size for controllers.\n", 
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "MEDIUM_LARGE", 
    "LARGE"
  ], 
  "id": "ClusterNodeVMFormFactor", 
  "module_id": "ClusterNodeVMDeployment", 
  "title": "Supported VM form factor for cluster nodes", 
  "type": "string"
}

ClusterProfile (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ClusterProfile", 
  "module_id": "ClusterProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType"+, 
      "help_summary": "The cluster profile type.", 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ClusterProfileListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ClusterProfileListParameters", 
  "module_id": "ClusterProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_system_owned": {
      "default": true, 
      "required": false, 
      "title": "Whether the list result contains system resources", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType"+, 
      "required": false, 
      "title": "Type of cluster profile"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ClusterProfile List Parameters", 
  "type": "object"
}

ClusterProfileListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ClusterProfileListResult", 
  "module_id": "ClusterProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ClusterProfile"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Cluster Profile Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Cluster Profile queries result", 
  "type": "object"
}

ClusterProfileType (type) 

{
  "enum": [
    "EdgeHighAvailabilityProfile", 
    "BridgeHighAvailabilityClusterProfile"
  ], 
  "id": "ClusterProfileType", 
  "module_id": "ClusterProfile", 
  "title": "Supported cluster profiles.", 
  "type": "string"
}

ClusterProfileTypeIdEntry (type) 

{
  "id": "ClusterProfileTypeIdEntry", 
  "module_id": "ClusterProfile", 
  "properties": {
    "profile_id": {
      "description": "key value", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType"+
    }
  }, 
  "type": "object"
}

ClusterRestoreStatus (type) 

{
  "id": "ClusterRestoreStatus", 
  "module_id": "ClusterRestore", 
  "properties": {
    "backup_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": true, 
      "title": "Timestamp when backup was initiated in epoch millisecond"
    }, 
    "endpoints": {
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "The list of allowed endpoints, based on the current state of\nthe restore process\n", 
      "type": "array"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique id for backup request", 
      "type": "string"
    }, 
    "instructions": {
      "items": {
        "$ref": "InstructionInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Instructions for users to reconcile Restore operations", 
      "type": "array"
    }, 
    "restore_end_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when restore was completed in epoch millisecond"
    }, 
    "restore_start_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when restore was started in epoch millisecond"
    }, 
    "status": {
      "$ref": "GlobalRestoreStatus"+
    }, 
    "step": {
      "$ref": "RestoreStep"+
    }, 
    "total_steps": {
      "readonly": true, 
      "required": true, 
      "title": "Total number of steps in the entire restore process", 
      "type": "integer"
    }
  }, 
  "title": "Cluster restore status", 
  "type": "object"
}

ClusterRoleConfig (type) 

{
  "additionalProperties": false, 
  "id": "ClusterRoleConfig", 
  "module_id": "ClusterManagement", 
  "properties": {
    "type": {
      "enum": [
        "ManagementClusterRoleConfig", 
        "ControllerClusterRoleConfig"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of this role configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusterStatus (type) 

{
  "additionalProperties": false, 
  "id": "ClusterStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "cluster_id": {
      "readonly": true, 
      "title": "Unique identifier of this cluster", 
      "type": "string"
    }, 
    "control_cluster_status": {
      "$ref": "ControllerClusterStatus"+, 
      "readonly": true, 
      "title": "The current status of the control cluster"
    }, 
    "mgmt_cluster_status": {
      "$ref": "ManagementClusterStatus"+, 
      "readonly": true, 
      "title": "The current status of the management cluster"
    }
  }, 
  "type": "object"
}

ClusteringInfo (type) 

{
  "description": "Clustering parameters for the controller cluster", 
  "id": "ClusteringInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "join_to_existing_cluster": {
      "description": "Property to indicate if the node must join an existing cluster.", 
      "required": true, 
      "title": "True If the controller node should join an existing cluster", 
      "type": "boolean"
    }, 
    "shared_secret": {
      "description": "Shared secret of the cluster.", 
      "required": true, 
      "sensitive": true, 
      "title": "Shared Secret of the cluster", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ClusteringStatus (type) 

{
  "enum": [
    "CONNECTED", 
    "DISCONNECTED", 
    "UNKNOWN"
  ], 
  "id": "ClusteringStatus", 
  "module_id": "ClusterManagement", 
  "type": "string"
}

ClustersAggregateInfo (type) 

{
  "additionalProperties": false, 
  "id": "ClustersAggregateInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "cluster_status": {
      "$ref": "AllClusterGroupStatus"+, 
      "required": true, 
      "title": "Status of all the cluster groups"
    }, 
    "controller_cluster": {
      "items": {
        "$ref": "ControllerNodeAggregateInfo"+
      }, 
      "required": true, 
      "title": "Array of Controller Nodes", 
      "type": "array"
    }, 
    "management_cluster": {
      "items": {
        "$ref": "ManagementNodeAggregateInfo"+
      }, 
      "required": true, 
      "title": "Array of Management Nodes", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ColumnItem (type) 

{
  "additionalProperties": false, 
  "description": "Represents a column of the Grid", 
  "id": "ColumnItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "column_identifier": {
      "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", 
      "type": "string"
    }, 
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "field": {
      "description": "Field from which values of the column will be derived.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Column Field", 
      "type": "string"
    }, 
    "hidden": {
      "default": false, 
      "description": "If set to true, hides the column", 
      "title": "Hide the column", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label"+, 
      "description": "Label of the column.", 
      "readonly": false, 
      "required": true, 
      "title": "Column Label"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "render_configuration": {
      "description": "Render configuration to be applied, if any.", 
      "items": {
        "$ref": "RenderConfiguration"+
      }, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "sort_ascending": {
      "default": true, 
      "description": "If true, the value of the column are sorted in ascending order. Otherwise, in descending order.", 
      "title": "Represents order of sorting the values", 
      "type": "boolean"
    }, 
    "sort_key": {
      "description": "Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.", 
      "maxLength": 255, 
      "title": "Key for sorting on this column", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over a cell in the grid.", 
      "items": {
        "$ref": "Tooltip"+
      }, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "type": {
      "default": "String", 
      "description": "Data type of the field.", 
      "enum": [
        "String", 
        "Number", 
        "Date"
      ], 
      "maxLength": 255, 
      "required": true, 
      "title": "Field data type", 
      "type": "string"
    }
  }, 
  "title": "Grid Column", 
  "type": "object"
}

CommunityMatchExpression (type) 

{
  "additionalProperties": false, 
  "id": "CommunityMatchExpression", 
  "module_id": "Routing", 
  "properties": {
    "expression": {
      "items": {
        "$ref": "CommunityMatchOperation"+
      }, 
      "required": true, 
      "title": "Array of community match operations", 
      "type": "array"
    }, 
    "operator": {
      "description": "Operator for evaluating community match expressions.\nAND logical AND operator\n", 
      "enum": [
        "AND"
      ], 
      "readonly": true, 
      "title": "Operator", 
      "type": "string"
    }
  }, 
  "title": "Community match expression", 
  "type": "object"
}

CommunityMatchOperation (type) 

{
  "additionalProperties": false, 
  "id": "CommunityMatchOperation", 
  "module_id": "Routing", 
  "properties": {
    "community_list_id": {
      "description": "ID of BGP community list. This value is not required when\nmatch_operator is MATCH_REGEX otherwise required.\n", 
      "title": "Community list id", 
      "type": "string"
    }, 
    "match_operator": {
      "default": "MATCH_ANY", 
      "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 will not match any community\nMATCH_REGEX will match community by evaluating regular\nexpression\n", 
      "enum": [
        "MATCH_ANY", 
        "MATCH_ALL", 
        "MATCH_EXACT", 
        "MATCH_NONE", 
        "MATCH_REGEX"
      ], 
      "title": "Match operator", 
      "type": "string"
    }, 
    "regular_expression": {
      "description": "Regular expression to match BGP communities. If match_operator\nis MATCH_REGEX then this value must be specified.\n", 
      "title": "Regular expression", 
      "type": "string"
    }
  }, 
  "title": "Community match operation", 
  "type": "object"
}

ComponentTargetVersion (type) 

{
  "id": "ComponentTargetVersion", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "target_version": {
      "readonly": true, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentTypeListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ComponentTypeListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade unit groups to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComponentUpgradeStatus (type) 

{
  "additionalProperties": false, 
  "id": "ComponentUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ComputeCollection (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource"+
  }, 
  "id": "ComputeCollection", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": true, 
      "title": "Local Id of the compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n", 
      "type": "string"
    }, 
    "origin_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the compute manager from where this Compute Collection was discovered", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of\ncompute collection in the Compute Manager\n", 
      "type": "array"
    }, 
    "origin_type": {
      "readonly": true, 
      "required": true, 
      "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", 
      "type": "string"
    }, 
    "owner_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the owner of compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ComputeCollectionFabricTemplate (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ComputeCollectionFabricTemplate", 
  "module_id": "ComputeCollectionHostPrepFabricService", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "auto_install_nsx": {
      "description": "Indicates whether NSX components should be automcatically installed. When 'true' NSX components will be automatically installed on the new host added to compute collection.", 
      "required": true, 
      "title": "Flag to enable/disable automatic install of NSX components", 
      "type": "boolean"
    }, 
    "compute_collection_id": {
      "required": true, 
      "title": "Associated compute collection id", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Compute collection fabric template", 
  "type": "object"
}

ComputeCollectionFabricTemplateListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ComputeCollectionFabricTemplateListResult", 
  "module_id": "ComputeCollectionHostPrepFabricService", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeCollectionFabricTemplate"+
      }, 
      "readonly": true, 
      "title": "List of compute collection fabric template", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of compute collection fabric template", 
  "type": "object"
}

ComputeCollectionListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ComputeCollectionListRequestParameters", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "cm_local_id": {
      "required": false, 
      "title": "Local Id of the compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "discovered_node_id": {
      "required": false, 
      "title": "Id of the discovered node which belongs to this Compute Collection\n", 
      "type": "string"
    }, 
    "display_name": {
      "required": false, 
      "title": "Name of the ComputeCollection in source compute manager", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "node_id": {
      "required": false, 
      "title": "Id of the fabric node created from a discovered node belonging to\nthis Compute Collection\n", 
      "type": "string"
    }, 
    "origin_id": {
      "required": false, 
      "title": "Id of the compute manager from where this Compute Collection was discovered", 
      "type": "string"
    }, 
    "origin_type": {
      "required": false, 
      "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", 
      "type": "string"
    }, 
    "owner_id": {
      "required": false, 
      "title": "Id of the owner of compute collection in the Compute Manager", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute Collection list parameters", 
  "type": "object"
}

ComputeCollectionListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ComputeCollectionListResult", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeCollection"+
      }, 
      "required": true, 
      "title": "Compute Collection list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute Collection list result", 
  "type": "object"
}

ComputeCollectionNetworkInterfacesListResult (type) 

{
  "description": "List of network interfaces for all discovered nodes in compute collection", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ComputeCollectionNetworkInterfacesListResult", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of discovered node with network interfaces", 
      "items": {
        "$ref": "DiscoveredNodeNetworkInterfaces"+
      }, 
      "required": true, 
      "title": "Discovered node network interfaces", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ComputeCollection Interfaces List Result", 
  "type": "object"
}

ComputeCollectionTransportNodeTemplate (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ComputeCollectionTransportNodeTemplate", 
  "module_id": "TransportNode", 
  "nsx_feature": "AutoTn", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "compute_collection_ids": {
      "items": {
        "title": "Compute collection id", 
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Associated compute collection ids", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "host_switch_spec": {
      "$ref": "HostSwitchSpec"+, 
      "description": "Property 'host_switch_spec' can be used to create either standard host switch or preconfigured host switch.", 
      "required": false, 
      "title": "Transport node host switch specification"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "network_migration_spec_ids": {
      "description": "Property 'network_migration_spec_ids' should only be used for compute collections which are clusters in VMware vCenter. Currently only HostProfileNetworkMigrationSpec type is supported. This specification will only apply to Stateless ESX hosts which are under this vCenter cluster.", 
      "items": {
        "$ref": "NetworkMigrationSpecTypeIdEntry"+
      }, 
      "maxItems": 1, 
      "nsx_feature": "HostProfileSupport", 
      "title": "Id(s) of Network migration specifications to be linked to compute collections", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zone_endpoints": {
      "items": {
        "$ref": "TransportZoneEndPoint"+
      }, 
      "required": false, 
      "title": "Transport zone endpoints", 
      "type": "array"
    }
  }, 
  "title": "Compute collection transport node template", 
  "type": "object"
}

ComputeCollectionTransportNodeTemplateState (type) 

{
  "id": "ComputeCollectionTransportNodeTemplateState", 
  "module_id": "TransportNode", 
  "nsx_feature": "AutoTn", 
  "properties": {
    "compute_collection_id": {
      "readonly": true, 
      "title": "Associated compute collection id", 
      "type": "string"
    }, 
    "template_states": {
      "items": {
        "$ref": "TransportNodeTemplateState"+
      }, 
      "readonly": true, 
      "title": "Transport node template states in compute collection", 
      "type": "array"
    }
  }, 
  "title": "Transport node state per compute collection", 
  "type": "object"
}

ComputeCollectionTransportNodeTemplateStateList (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ComputeCollectionTransportNodeTemplateStateList", 
  "module_id": "TransportNode", 
  "nsx_feature": "AutoTn", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeCollectionTransportNodeTemplateState"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "State list per compute collection", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport node creation state list", 
  "type": "object"
}

ComputeInstanceErrorMessage (type) 

{
  "additionalProperties": false, 
  "description": "Stores an error ID and error message", 
  "id": "ComputeInstanceErrorMessage", 
  "module_id": "CloudVirtualMachineInformation", 
  "properties": {
    "detailed_message": {
      "description": "Error message string to indicate, if it is NSX or cloud operation generated error.", 
      "readonly": true, 
      "required": true, 
      "title": "Error details", 
      "type": "string"
    }, 
    "error_id": {
      "readonly": true, 
      "required": true, 
      "title": "An error ID contract obtained from PCM", 
      "type": "integer"
    }
  }, 
  "title": "Compute Instance Error Message", 
  "type": "object"
}

ComputeManager (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ComputeManager", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "credential": {
      "$ref": "LoginCredential"+, 
      "readonly": false, 
      "required": false, 
      "title": "Login credentials for the compute manager"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of compute manager", 
      "type": "array"
    }, 
    "origin_type": {
      "readonly": false, 
      "required": true, 
      "title": "Compute manager type like vCenter", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "readonly": false, 
      "required": true, 
      "title": "IP address or hostname of compute manager", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ComputeManagerListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ComputeManagerListRequestParameters", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "origin_type": {
      "readonly": false, 
      "required": false, 
      "title": "Compute manager type like vCenter", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "readonly": false, 
      "required": false, 
      "title": "IP address or hostname of compute manager", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute manager list parameters", 
  "type": "object"
}

ComputeManagerListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ComputeManagerListResult", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeManager"+
      }, 
      "required": true, 
      "title": "List of compute managers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of compute managers", 
  "type": "object"
}

ConditionalForwarderZone (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ForwarderZone"+
  }, 
  "id": "ConditionalForwarderZone", 
  "module_id": "DnsForwarder", 
  "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", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 100, 
      "minItems": 1, 
      "required": true, 
      "title": "Domain names of a forwarder zone", 
      "type": "array"
    }, 
    "source_ip": {
      "$ref": "IPv4Address"+, 
      "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", 
      "required": false, 
      "title": "Source ip of the forwarder"
    }, 
    "upstream_servers": {
      "description": "Ip address of the upstream dns servers the dns forwarder accesses.\n", 
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 3, 
      "minItems": 1, 
      "required": true, 
      "title": "Ips of upsteam dns servers", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ConfigurationState (type) 

{
  "id": "ConfigurationState", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Describes status of configuration of an entity", 
  "type": "object"
}

ConfigurationStateElement (type) 

{
  "id": "ConfigurationStateElement", 
  "module_id": "Common", 
  "properties": {
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "in_progress", 
        "success", 
        "failed", 
        "partial_success"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "State of configuration on this sub system", 
      "type": "string"
    }, 
    "sub_system_address": {
      "readonly": true, 
      "required": false, 
      "title": "URI of backing resource on sub system", 
      "type": "string"
    }, 
    "sub_system_id": {
      "readonly": true, 
      "required": false, 
      "title": "Identifier of backing resource on sub system", 
      "type": "string"
    }, 
    "sub_system_type": {
      "readonly": true, 
      "required": false, 
      "title": "Type of backing resource on sub system", 
      "type": "string"
    }
  }, 
  "title": "Describes status of configuration of an entity", 
  "type": "object"
}

ContainerConfiguration (type) 

{
  "additionalProperties": false, 
  "description": "Represents a container to group widgets that belong to a common category or have a common purpose.", 
  "extends": {
    "$ref": "WidgetConfiguration"+
  }, 
  "id": "ContainerConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ContainerConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "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.", 
      "items": {
        "$ref": "Datasource"+
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "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.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "footer": {
      "$ref": "Footer"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "labels": {
      "description": "Labels for the container.", 
      "items": {
        "$ref": "Label"+
      }, 
      "minItems": 0, 
      "title": "Labels", 
      "type": "array"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "default": 2, 
      "description": "Represents the horizontal span of the container.", 
      "title": "Number of widgets to be held in this container horizontally", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }, 
    "widgets": {
      "description": "If not specified, creates an empty container.", 
      "items": {
        "$ref": "WidgetItem"+
      }, 
      "minItems": 0, 
      "title": "Widgets held by the container", 
      "type": "array"
    }
  }, 
  "title": "Container that holds widgets", 
  "type": "object"
}

ContentFilterValue (type) 

{
  "enum": [
    "ALL", 
    "DEFAULT"
  ], 
  "id": "ContentFilterValue", 
  "title": "Support bundle content filter allowed values", 
  "type": "string"
}

ContinueRequestParameters (type) 

{
  "additionalProperties": false, 
  "id": "ContinueRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "skip": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Skip to upgrade of next component.", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ControlClusterNodeStatus (type) 

{
  "additionalProperties": false, 
  "id": "ControlClusterNodeStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "control_cluster_status": {
      "$ref": "ClusteringStatus"+, 
      "readonly": true, 
      "title": "Status of this node's connection to the control cluster"
    }, 
    "mgmt_connection_status": {
      "$ref": "MgmtConnStatus"+, 
      "readonly": true, 
      "title": "Status of this node's management plane connection"
    }
  }, 
  "type": "object"
}

ControlConnStatus (type) 

{
  "id": "ControlConnStatus", 
  "module_id": "FabricNode", 
  "properties": {
    "control_node_ip": {
      "readonly": true, 
      "required": true, 
      "title": "IP address of the control Node.", 
      "type": "string"
    }, 
    "failure_status": {
      "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"
      ], 
      "help_detail": "CONNECTION_REFUSED \"Connection refused by control node\"\nINCOMPLETE_HOST_CERT \"Incomplete host certificate\"\nINCOMPLETE_CONTROLLER_CERT \"Incomplete controller certificate\"\nCONTROLLER_REJECTED_HOST_CERT \"Controller rejected host certificate\"\nHOST_REJECTED_CONTROLLER_CERT \"Host rejected controller certificate\"\nKEEP_ALIVE_TIMEOUT \"Keep alive timeout\"\nOTHER_SSL_ERROR \"Other ssl error\"\nOTHER_ERROR \"Other error\".\n", 
      "readonly": true, 
      "required": false, 
      "title": "Failure status of the control Node for e.g CONNECTION_REFUSED,INCOMPLETE_HOST_CERT.", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "help_detail": "UP \"Control node is up\"\nDown \"Control node is down\".\n", 
      "readonly": true, 
      "required": true, 
      "title": "Status of the control Node for e.g  UP, DOWN.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ControllerClusterRoleConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ClusterRoleConfig"+
  }, 
  "id": "ControllerClusterRoleConfig", 
  "module_id": "ClusterManagement", 
  "properties": {
    "control_cluster_listen_addr": {
      "$ref": "ServiceEndpoint"+, 
      "readonly": true, 
      "title": "The IP and port for the control cluster service on this node"
    }, 
    "control_plane_listen_addr": {
      "$ref": "ServiceEndpoint"+, 
      "readonly": true, 
      "title": "The IP and port for the control plane service on this node"
    }, 
    "host_msg_client_info": {
      "$ref": "MsgClientInfo"+
    }, 
    "mpa_msg_client_info": {
      "$ref": "MsgClientInfo"+
    }, 
    "type": {
      "enum": [
        "ManagementClusterRoleConfig", 
        "ControllerClusterRoleConfig"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of this role configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ControllerClusterStatus (type) 

{
  "additionalProperties": false, 
  "id": "ControllerClusterStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "status": {
      "enum": [
        "UNSTABLE", 
        "STABLE", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "The current status of the controller cluster", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ControllerNodeAggregateInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseNodeAggregateInfo"+
  }, 
  "id": "ControllerNodeAggregateInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "display_name": {
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "node_interface_properties": {
      "items": {
        "$ref": "NodeInterfaceProperties"+
      }, 
      "readonly": true, 
      "title": "Array of Node interface statistic properties", 
      "type": "array"
    }, 
    "node_interface_statistics": {
      "items": {
        "$ref": "NodeInterfaceStatisticsProperties"+
      }, 
      "readonly": true, 
      "title": "Array of Node network interface statistic properties", 
      "type": "array"
    }, 
    "node_status": {
      "$ref": "ClusterNodeStatus"+, 
      "readonly": true
    }, 
    "node_status_properties": {
      "items": {
        "$ref": "NodeStatusProperties"+
      }, 
      "title": "Time series of the node's system properties", 
      "type": "array"
    }, 
    "role_config": {
      "$ref": "ControllerClusterRoleConfig"+, 
      "readonly": true
    }
  }, 
  "type": "object"
}

CookiePersistenceModeType (type) 

{
  "additionalProperties": false, 
  "description": "If the persistence cookie is found in the incoming request, value of the\ncookie is used to identify the server that this request should be sent to.\nIf the cookie is not found, then the server selection algorithm is used to\nselect a new server to handle that request.\nThree different modes of cookie persistence are supported: insert, prefix\nand rewrite.\nIn cookie insert mode, a cookie is inserted by load balancer in the HTTP\nresponse going from server to client.\nIn cookie prefix and rewrite modes, server controls the cookie and load\nbalancer only manipulates the value of the cookie. In prefix mode, server's\ncookie value is prepended with the server IP and port and then sent to the\nclient. In rewrite mode, entire server's cookie value is replaced with the\nserver IP and port in the response before sending it to the client.\n", 
  "enum": [
    "INSERT", 
    "PREFIX", 
    "REWRITE"
  ], 
  "id": "CookiePersistenceModeType", 
  "module_id": "LoadBalancer", 
  "title": "cookie persistence mode", 
  "type": "string"
}

CookieTimeType (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "CookieTimeType", 
  "module_id": "LoadBalancer", 
  "title": "Snat translation type", 
  "type": "string"
}

CopyFromRemoteFileProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties"+
  }, 
  "id": "CopyFromRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "Protocol"+, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CopyRemoteFileProperties (type) 

{
  "additionalProperties": {}, 
  "id": "CopyRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CopyToRemoteFileProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties"+
  }, 
  "id": "CopyToRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "Protocol"+, 
      "description": "Only scp and sftp may be used.", 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CpuCoreConfigForEnhancedNetworkingStackSwitch (type) 

{
  "description": "Non Uniform Memory Access (NUMA) nodes and Logical cpu cores (Lcores) per NUMA node configuration for Enhanced Networking Stack enabled HostSwitch.", 
  "id": "CpuCoreConfigForEnhancedNetworkingStackSwitch", 
  "module_id": "TransportNode", 
  "properties": {
    "num_lcores": {
      "minimum": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Number of Logical cpu cores (Lcores) to be placed on a specified NUMA node", 
      "type": "int"
    }, 
    "numa_node_index": {
      "minimum": 0, 
      "readonly": false, 
      "required": true, 
      "title": "Unique index of the Non Uniform Memory Access (NUMA) node", 
      "type": "int"
    }
  }, 
  "title": "Enhanced Networking Stack CPU configuration", 
  "type": "object"
}

CreateRemoteDirectoryProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties"+
  }, 
  "id": "CreateRemoteDirectoryProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "SftpProtocol"+, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Crl (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "Crl", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "details": {
      "$ref": "X509Crl"+, 
      "description": "details of the X509Crl object", 
      "readonly": true, 
      "required": false
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "pem encoded crl data", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CrlList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "CrlList", 
  "module_id": "CertificateManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "CRL list", 
      "items": {
        "$ref": "Crl"+
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Crl queries result", 
  "type": "object"
}

CrlObjectData (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "CrlObjectData", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "pem encoded crl data", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CryptoAlgorithm (type) 

{
  "additionalProperties": false, 
  "id": "CryptoAlgorithm", 
  "module_id": "CertificateManager", 
  "properties": {
    "key_size": {
      "description": "supported key sizes for the algorithm", 
      "items": {
        "$ref": "KeySize"+
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "name": {
      "description": "crypto algorithm name", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

CsmConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "CsmConfig", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "csm_appliance_status": {
      "enum": [
        "UNINITIALIZED", 
        "INITIALIZED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Csm appliance status", 
      "type": "string"
    }, 
    "gateway_image_url": {
      "description": "URL that points to JSON file containing details of gateway image.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Gateway Image URL", 
      "type": "string"
    }, 
    "single_region": {
      "description": "This property is used only if CSM is running in service mode", 
      "readonly": false, 
      "required": false, 
      "title": "Specifies whether this is a single/multi region deployment", 
      "type": "boolean"
    }
  }, 
  "title": "Information about status of cloud service manager", 
  "type": "object"
}

CsmStatus (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "CsmStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the Csm instance", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the Csm appliance", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of the Csm appliance", 
      "type": "string"
    }, 
    "ip_address": {
      "readonly": true, 
      "required": false, 
      "title": "IP address of Csm instance", 
      "type": "string"
    }, 
    "managed_by_vmware": {
      "description": "This property is used only if CSM is running in service mode", 
      "readonly": true, 
      "required": false, 
      "title": "Mode of running of Csm instance", 
      "type": "boolean"
    }, 
    "supported_clouds": {
      "description": "This property provides the list of names of supported clouds by CSM.\n", 
      "items": {
        "$ref": "CloudTypeInfo"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Indication of clouds supported by CSM", 
      "type": "array"
    }, 
    "version": {
      "readonly": true, 
      "required": true, 
      "title": "Version of Csm", 
      "type": "string"
    }
  }, 
  "title": "Information about status of cloud service manager", 
  "type": "object"
}

Csr (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "Csr", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "algorithm": {
      "description": "Cryptographic algorithm(asymmetric ) used by the public key for data encryption", 
      "enum": [
        "RSA", 
        "DSA"
      ], 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key_size": {
      "description": "size measured in bits of the public key used in a cryptographic algorithm", 
      "readonly": false, 
      "required": true, 
      "type": "integer"
    }, 
    "pem_encoded": {
      "description": "pem encoded certificate data", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "subject": {
      "$ref": "Principal"+, 
      "description": "the certificate owner's information (CN, O, OU, C, ST, L)", 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

CsrList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "CsrList", 
  "module_id": "CertificateManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "CSR list", 
      "items": {
        "$ref": "Csr"+
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Csr queries result", 
  "type": "object"
}

CsvListResult (type) 

{
  "abstract": true, 
  "description": "Base type for CSV result.", 
  "id": "CsvListResult", 
  "module_id": "CsvTypes", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CsvRecord (type) 

{
  "abstract": true, 
  "description": "Base type for CSV records.", 
  "id": "CsvRecord", 
  "module_id": "CsvTypes", 
  "type": "object"
}

CurrentBackupOperationStatus (type) 

{
  "additionalProperties": false, 
  "id": "CurrentBackupOperationStatus", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "backup_id": {
      "required": false, 
      "title": "Unique identifier of current backup", 
      "type": "string"
    }, 
    "current_step": {
      "enum": [
        "BACKUP_CREATING_CLUSTER_BACKUP", 
        "BACKUP_CREATING_NODE_BACKUP"
      ], 
      "required": false, 
      "title": "Current step of operation", 
      "type": "string"
    }, 
    "current_step_message": {
      "required": false, 
      "title": "Additional human-readable status information about current step", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "Time when operation is expected to end"
    }, 
    "operation_type": {
      "enum": [
        "NONE", 
        "BACKUP"
      ], 
      "required": true, 
      "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", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp"+, 
      "required": false, 
      "title": "Time when operation was started"
    }
  }, 
  "title": "Current backup operation status", 
  "type": "object"
}

DHGroup (type) 

{
  "additionalProperties": false, 
  "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.\n", 
  "enum": [
    "GROUP2", 
    "GROUP5", 
    "GROUP14", 
    "GROUP15", 
    "GROUP16"
  ], 
  "id": "DHGroup", 
  "module_id": "IPSecVPN", 
  "title": "Diffie-Hellman groups", 
  "type": "string"
}

DSAppliedToType (type) 

{
  "enum": [
    "NSGroup", 
    "LogicalSwitch", 
    "LogicalRouter", 
    "LogicalPort"
  ], 
  "id": "DSAppliedToType", 
  "module_id": "DistributedServices", 
  "title": "Resource type valid for use as AppliedTo filter in section API", 
  "type": "string"
}

DSListRequestParameters (type) 

{
  "abstract": true, 
  "description": "Pagination and Filtering parameters to get only a subset of sections/rules.", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DSListRequestParameters", 
  "module_id": "DistributedServices", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type\n'FILTER' will ensure all criterias (sources, destinations, services,\nappliedtos) are matched. Type 'SEARCH' will match any of the given\ncriteria.\n", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter list of sections/rules.", 
  "type": "object"
}

DSRule (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "EmbeddedResource"+
  }, 
  "id": "DSRule", 
  "module_id": "DistributedServices", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink"+, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "action": {
      "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).", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT", 
        "REDIRECT", 
        "DO_NOT_REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Action", 
      "type": "string"
    }, 
    "applied_tos": {
      "description": "List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of the destinations. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Destination List", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "Negation of the destination.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "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.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Rule direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable rule. Disabled will only be persisted but never provisioned/realized.", 
      "readonly": false, 
      "required": false, 
      "title": "Rule enable/disable flag", 
      "type": "boolean"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the resource", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "ip_protocol": {
      "default": "IPV4_IPV6", 
      "description": "Type of IP packet that should be matched while enforcing the rule.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "Flag to indicate whether rule is default.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "User notes specific to the rule.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Notes", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "maxLength": 32, 
      "readonly": false, 
      "required": false, 
      "title": "Tag", 
      "type": "string"
    }, 
    "services": {
      "description": "List of the services. Null will be treated as any.", 
      "items": {
        "$ref": "DSService"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Service List", 
      "type": "array"
    }, 
    "sources": {
      "description": "List of sources. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Source List", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "Negation of the source.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

DSRuleState (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConfigurationState"+
  }, 
  "id": "DSRuleState", 
  "module_id": "DistributedServices", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "revision_desired": {
      "readonly": true, 
      "required": false, 
      "title": "revision number of the desired state", 
      "type": "integer"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DSSection (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DSSection", 
  "module_id": "DistributedServices", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "applied_tos": {
      "description": "List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Default section flag", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "section_type": {
      "description": "Type of the rules which a section can contain. Only homogeneous sections are supported.", 
      "enum": [
        "LAYER2", 
        "LAYER3", 
        "L3REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Section Type", 
      "type": "string"
    }, 
    "stateful": {
      "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.", 
      "readonly": false, 
      "required": true, 
      "title": "Stateful nature of the distributed service rules in the section.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DSSectionListResult (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DSSectionListResult", 
  "module_id": "DistributedServices", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of the distributed service sections. The list has to be homogenous.", 
      "items": {
        "$ref": "DSSection"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Section list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DSSectionState (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConfigurationState"+
  }, 
  "id": "DSSectionState", 
  "module_id": "DistributedServices", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "revision_desired": {
      "readonly": true, 
      "required": false, 
      "title": "revision number of the desired state", 
      "type": "integer"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DSService (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "ResourceReference"+
  }, 
  "id": "DSService", 
  "module_id": "DistributedServices", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "service": {
      "$ref": "NSServiceElement"+, 
      "description": "Distributed Service API accepts raw protocol and ports as part of NS service element\nin Distributed Service Rule that describes traffic corresponding to an NSService.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Distributed Service Network and Security Service element"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DailyTelemetrySchedule (type) 

{
  "extends": {
    "$ref": "TelemetrySchedule"+
  }, 
  "id": "DailyTelemetrySchedule", 
  "module_id": "TelemetryConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DailyTelemetrySchedule"
  }, 
  "properties": {
    "frequency_type": {
      "description": "Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.", 
      "required": true, 
      "title": "Frequency at which data will be collected", 
      "type": "string"
    }, 
    "hour_of_day": {
      "description": "Hour at which data will be collected. Specify a value between 0 through 23.\n", 
      "maximum": 23, 
      "minimum": 0, 
      "required": true, 
      "title": "Hour at which data will be collected", 
      "type": "integer"
    }, 
    "minutes": {
      "default": 0, 
      "description": "Minute at which data will be collected. Specify a value between 0 through 59.\n", 
      "maximum": 59, 
      "minimum": 0, 
      "required": false, 
      "title": "Minute at which data will be collected", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DataSourceParameters (type) 

{
  "id": "DataSourceParameters", 
  "module_id": "Types", 
  "properties": {
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

DataSourceType (type) 

{
  "enum": [
    "realtime", 
    "cached"
  ], 
  "id": "DataSourceType", 
  "module_id": "Types", 
  "title": "Data source type.", 
  "type": "string"
}

DataTypeCollectionConfiguration (type) 

{
  "id": "DataTypeCollectionConfiguration", 
  "module_id": "AggSvcDataCollectionConfig", 
  "properties": {
    "collection_frequency": {
      "description": "The frequency in seconds at which data is collected", 
      "maximum": 86400, 
      "minimum": 15, 
      "required": true, 
      "title": "Data Collection Frequency In Seconds", 
      "type": "integer"
    }, 
    "data_type": {
      "description": "Defines the type of data being collected", 
      "enum": [
        "STATUS", 
        "STATISTICS"
      ], 
      "required": true, 
      "title": "Data type", 
      "type": "string"
    }
  }, 
  "title": "Data type collection configuration", 
  "type": "object"
}

Datasource (type) 

{
  "additionalProperties": false, 
  "description": "An instance of a datasource configuration.", 
  "id": "Datasource", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "display_name": {
      "description": "Name of a datasource instance.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Datasource instance's display name", 
      "type": "string"
    }, 
    "urls": {
      "description": "Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.", 
      "items": {
        "$ref": "UrlAlias"+
      }, 
      "required": true, 
      "title": "Array of relative urls and their aliases", 
      "type": "array"
    }
  }, 
  "title": "Datasource Instance", 
  "type": "object"
}

DeploymentConfig (type) 

{
  "additionalProperties": false, 
  "id": "DeploymentConfig", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "placement_type"
  }, 
  "properties": {
    "placement_type": {
      "enum": [
        "VsphereDeploymentConfig"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

DeploymentSpec (type) 

{
  "additionalProperties": false, 
  "id": "DeploymentSpec", 
  "module_id": "HostPrepServiceFabric", 
  "properties": {
    "fabric_module_version": {
      "required": true, 
      "title": "version of fabric module", 
      "type": "string"
    }, 
    "versioned_deployment_specs": {
      "items": {
        "$ref": "VersionedDeploymentSpec"+
      }, 
      "required": true, 
      "title": "List of Versioned deployment specs", 
      "type": "array"
    }
  }, 
  "title": "Deployment spec is a specific version of fabric module", 
  "type": "object"
}

DeploymentTemplate (type) 

{
  "description": "Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX.", 
  "id": "DeploymentTemplate", 
  "module_id": "ServiceInsertionCommonTypes", 
  "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.", 
      "items": {
        "$ref": "Attribute"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Deployment Template attributes", 
      "type": "array"
    }, 
    "name": {
      "description": "Deployment Template name.", 
      "readonly": false, 
      "required": false, 
      "title": "name", 
      "type": "string"
    }
  }, 
  "title": "Service Deployment Template", 
  "type": "object"
}

DeploymentTypeListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DeploymentTypeListRequestParameters", 
  "module_id": "EdgeCommonTypes", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "deployment_type": {
      "$ref": "EdgeDeploymentType"+, 
      "required": false
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "member_node_type": {
      "$ref": "EdgeClusterNodeType"+, 
      "required": false
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DestinationFilteringConfiguration (type) 

{
  "description": "It is used to configure the reputation and category provider. It can also be used to enable or disable the destination filtering feature by setting the enable property.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DestinationFilteringConfiguration", 
  "module_id": "ManagerNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "customer_id": {
      "description": "The unique ID assigned to a customer.", 
      "readonly": false, 
      "required": true, 
      "title": "Customer ID", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Flag to enable or disable the feature.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable feature", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "provider_url": {
      "description": "URL of the provider which provides the reputation and category databases.", 
      "readonly": false, 
      "required": true, 
      "title": "Provider URL", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Destination filtering configuration", 
  "type": "object"
}

DhcpFilter (type) 

{
  "id": "DhcpFilter", 
  "module_id": "SwitchSecuritySwitchingProfile", 
  "properties": {
    "client_block_enabled": {
      "readonly": false, 
      "required": true, 
      "title": "Indicates whether DHCP client blocking is enabled", 
      "type": "boolean"
    }, 
    "server_block_enabled": {
      "readonly": false, 
      "required": true, 
      "title": "Indicates whether DHCP server blocking is enabled", 
      "type": "boolean"
    }
  }, 
  "title": "DHCP filtering configuration", 
  "type": "object"
}

DhcpIpPool (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "IpAllocationBase"+
  }, 
  "id": "DhcpIpPool", 
  "module_id": "Dhcp", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allocation_ranges": {
      "items": {
        "$ref": "IpPoolRange"+
      }, 
      "required": true, 
      "title": "ip-ranges", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "error_threshold": {
      "default": 100, 
      "maximum": 100, 
      "minimum": 80, 
      "required": false, 
      "title": "error threshold, valid [80-100], default 100", 
      "type": "integer"
    }, 
    "gateway_ip": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "gateway ip"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lease_time": {
      "default": 86400, 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "lease time, in seconds, [60-(2^32-1)], default 86400", 
      "type": "integer"
    }, 
    "options": {
      "$ref": "DhcpOptions"+, 
      "description": "If an option is defined at server level and not configred at\nip-pool/static-binding level, the option will be inherited to\nip-pool/static-binding. If both define a same-code option, the\noption defined at ip-pool/static-binding level take precedence\nover that defined at server level.\n", 
      "required": false, 
      "title": "dhcp options"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "warning_threshold": {
      "default": 80, 
      "maximum": 80, 
      "minimum": 50, 
      "required": false, 
      "title": "warning threshold, valid [50-80], default 80", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

DhcpIpPoolListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DhcpIpPoolListResult", 
  "module_id": "Dhcp", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpIpPool"+
      }, 
      "required": true, 
      "title": "paginated list of dhcp ip pools", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpLeaseRequestParameters (type) 

{
  "extends": {
    "$ref": "DataSourceParameters"+
  }, 
  "id": "DhcpLeaseRequestParameters", 
  "module_id": "AggSvcDhcp", 
  "properties": {
    "address": {
      "required": false, 
      "title": "can be an ip address, or an ip range, or a mac address", 
      "type": "string"
    }, 
    "pool_id": {
      "required": false, 
      "title": "The uuid of dhcp ip pool", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

DhcpOption121 (type) 

{
  "additionalProperties": false, 
  "id": "DhcpOption121", 
  "module_id": "Dhcp", 
  "properties": {
    "static_routes": {
      "items": {
        "$ref": "ClasslessStaticRoute"+
      }, 
      "maxItems": 27, 
      "minItems": 1, 
      "required": true, 
      "title": "dhcp classless static routes", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpOptions (type) 

{
  "additionalProperties": false, 
  "id": "DhcpOptions", 
  "module_id": "Dhcp", 
  "properties": {
    "option121": {
      "$ref": "DhcpOption121"+, 
      "required": false, 
      "title": "option 121"
    }, 
    "others": {
      "items": {
        "$ref": "GenericDhcpOption"+
      }, 
      "maxItems": 255, 
      "minItems": 0, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DhcpProfile", 
  "module_id": "Dhcp", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_id": {
      "required": true, 
      "title": "edge cluster uuid", 
      "type": "string"
    }, 
    "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.\nIf both the member indexes are changed in a same PUT API, e.g. change from [a,b] to [x,y],\nthe current dhcp server states 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, e.g. from [a,b] to [a,y].\n", 
      "items": {
        "type": "integer"
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "edge node indexes", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DhcpProfileListResult", 
  "module_id": "Dhcp", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpProfile"+
      }, 
      "required": true, 
      "title": "paginated list of dhcp profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpRelayProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DhcpRelayProfile", 
  "module_id": "DhcpRelay", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "server_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": true, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpRelayProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DhcpRelayProfileListResult", 
  "module_id": "DhcpRelay", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpRelayProfile"+
      }, 
      "required": true, 
      "title": "Dhcp relay profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpRelayService (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DhcpRelayService", 
  "module_id": "DhcpRelay", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_relay_profile_id": {
      "required": true, 
      "title": "dhcp relay profile referenced by the dhcp relay service", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpRelayServiceListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DhcpRelayServiceListResult", 
  "module_id": "DhcpRelay", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpRelayService"+
      }, 
      "required": true, 
      "title": "Dhcp relay service list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DhcpStaticBinding (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "IpAllocationBase"+
  }, 
  "id": "DhcpStaticBinding", 
  "module_id": "Dhcp", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "gateway_ip": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "gateway ip"
    }, 
    "host_name": {
      "format": "hostname", 
      "required": false, 
      "title": "host name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "ip addres"
    }, 
    "lease_time": {
      "default": 86400, 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "lease time, in seconds, [60-(2^32-1)], default 86400", 
      "type": "integer"
    }, 
    "mac_address": {
      "$ref": "MACAddress"+, 
      "required": true, 
      "title": "mac address"
    }, 
    "options": {
      "$ref": "DhcpOptions"+, 
      "description": "If an option is defined at server level and not configred at\nip-pool/static-binding level, the option will be inherited to\nip-pool/static-binding. If both define a same-code option, the\noption defined at ip-pool/static-binding level take precedence\nover that defined at server level.\n", 
      "required": false, 
      "title": "dhcp options"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DhcpStaticBindingListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DhcpStaticBindingListResult", 
  "module_id": "Dhcp", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DhcpStaticBinding"+
      }, 
      "required": true, 
      "title": "paginated list of dhcp static bindings", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DirectionType (type) 

{
  "default": "BIDIRECTIONAL", 
  "enum": [
    "INGRESS", 
    "EGRESS", 
    "BIDIRECTIONAL"
  ], 
  "id": "DirectionType", 
  "module_id": "PortMirroringSwitchingProfile", 
  "title": "port mirroring direction", 
  "type": "string"
}

DirectoryAdDomain (type) 

{
  "extends": {
    "$ref": "DirectoryDomain"+
  }, 
  "id": "DirectoryAdDomain", 
  "module_id": "ManagerNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DirectoryAdDomain"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "base_distinguished_name": {
      "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.", 
      "required": false, 
      "title": "Directory domain base distinguished name", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "name": {
      "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.", 
      "required": true, 
      "title": "Directory domain name", 
      "type": "string"
    }, 
    "resource_type": {
      "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.", 
      "required": true, 
      "title": "Directory domain resource type", 
      "type": "string"
    }, 
    "sync_settings": {
      "$ref": "DirectoryDomainSyncSettings"+, 
      "description": "Each domain sync settings can be changed using this object. It is not required since there are default values used if there is no specification for this object.", 
      "required": false, 
      "title": "Directory domain sync settings"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Active Directory Domain", 
  "type": "object"
}

DirectoryAdGroup (type) 

{
  "extends": {
    "$ref": "DirectoryGroup"+
  }, 
  "id": "DirectoryAdGroup", 
  "module_id": "ManagerNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DirectoryAdGroup"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "distinguished_name": {
      "required": true, 
      "title": "Directory group distinguished name", 
      "type": "string"
    }, 
    "domain_id": {
      "description": "Domain ID this directory group belongs to.", 
      "required": true, 
      "title": "Domain id", 
      "type": "string"
    }, 
    "domain_sync_node_id": {
      "description": "Domain sync node under which this directory group is located.", 
      "required": true, 
      "title": "Domain synchronization root node id", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "object_guid": {
      "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.", 
      "required": true, 
      "title": "Active directory group object guid", 
      "type": "string"
    }, 
    "resource_type": {
      "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.", 
      "required": true, 
      "title": "Directory group resource type for this domain", 
      "type": "string"
    }, 
    "secure_id": {
      "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.", 
      "required": true, 
      "title": "Active directory group secure id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DirectoryDomain (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DirectoryDomain", 
  "module_id": "ManagerNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "name": {
      "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.", 
      "required": true, 
      "title": "Directory domain name", 
      "type": "string"
    }, 
    "resource_type": {
      "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.", 
      "required": true, 
      "title": "Directory domain resource type", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Directory Domain", 
  "type": "object"
}

DirectoryDomainListResults (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DirectoryDomainListResults", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryDomain"+
      }, 
      "maxItems": 500, 
      "required": true, 
      "title": "List of Directory Domains", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Directory Domain", 
  "type": "object"
}

DirectoryDomainSyncNode (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DirectoryDomainSyncNode", 
  "module_id": "ManagerNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "distinguished_name": {
      "description": "Distinguished name of the domain sync node", 
      "required": true, 
      "title": "Distinguished name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Directory Domain Synchronization Nodes", 
  "type": "object"
}

DirectoryDomainSyncNodeListResults (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DirectoryDomainSyncNodeListResults", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryDomainSyncNode"+
      }, 
      "required": true, 
      "title": "List of Directory Domain Synchronization Nodes", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Directory Domain Synchronization Nodes", 
  "type": "object"
}

DirectoryDomainSyncRemoteNodes (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DirectoryDomainSyncRemoteNodes", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Directory domain sync remote node candidate", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Domain synchronzation node list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Directory Domain sync remote nodes", 
  "type": "object"
}

DirectoryDomainSyncSettings (type) 

{
  "additionalProperties": false, 
  "id": "DirectoryDomainSyncSettings", 
  "module_id": "ManagerNode", 
  "properties": {
    "delta_sync_interval": {
      "default": 180, 
      "description": "Directory domain delta synchronization interval time between two delta sync in minutes.", 
      "min": 30, 
      "required": false, 
      "title": "Delta synchronization inverval in minutes", 
      "type": "integer"
    }, 
    "full_sync_cron_expr": {
      "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.", 
      "required": false, 
      "title": "Full synchronization cron expression", 
      "type": "string"
    }, 
    "sync_entire_domain": {
      "default": false, 
      "description": "This flag will decide whether to synchronize the directory objects under entire domain or configured synchronization nodes.", 
      "required": false, 
      "title": "Sync entire domain flag", 
      "type": "boolean"
    }
  }, 
  "title": "Domain synchronization settings", 
  "type": "object"
}

DirectoryDomainSyncStats (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DirectoryDomainSyncStats", 
  "module_id": "ManagerNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "avg_delta_sync_time": {
      "description": "All the historical delta sync are counted in calculating the average delta sync time in seconds.", 
      "readonly": true, 
      "required": false, 
      "title": "Average time spent for all historical delta sync", 
      "type": "integer"
    }, 
    "avg_full_sync_time": {
      "description": "All the historical full sync are counted in calculating the average full sync time in seconds.", 
      "readonly": true, 
      "required": false, 
      "title": "Average time spent for all historical full sync", 
      "type": "integer"
    }, 
    "current_state": {
      "description": "Current running state of the directory domain in synchronization life cycle. It could be one of the following three states.", 
      "enum": [
        "IDLE", 
        "FULL_SYNC", 
        "DELTA_SYNC"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Current state of directory domain sync context", 
      "type": "string"
    }, 
    "current_state_begin_time": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Since what time the current state has begun. The time is expressed in millisecond epoch time.", 
      "readonly": true, 
      "required": true, 
      "title": "Current state elapsed time"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "num_delta_sync": {
      "description": "number of historical delta sync initiated either by system or by API request.", 
      "readonly": true, 
      "required": false, 
      "title": "Total number of delta sync", 
      "type": "integer"
    }, 
    "num_full_sync": {
      "description": "number of historical full sync initiated either by system or by API request.", 
      "readonly": true, 
      "required": false, 
      "title": "Total number of full sync", 
      "type": "integer"
    }, 
    "prev_sync_end_time": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Directory domain previous sync ending time expressed in millisecond epoch time.", 
      "readonly": true, 
      "required": true, 
      "title": "Previous sync ended time"
    }, 
    "prev_sync_status": {
      "description": "Directory domain previous sync status. It could be one of the following two states.", 
      "enum": [
        "SUCCESS", 
        "FAILURE", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Previous sync status", 
      "type": "string"
    }, 
    "prev_sync_type": {
      "description": "Directory domain previous sync type. It could be one of the following three states. Right after the directory domain is configured, this field is set to IDLE.", 
      "enum": [
        "IDLE", 
        "FULL_SYNC", 
        "DELTA_SYNC"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Previous sync type", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Directory Domain Synchronization Statistics", 
  "type": "object"
}

DirectoryGroup (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DirectoryGroup", 
  "module_id": "ManagerNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "distinguished_name": {
      "required": true, 
      "title": "Directory group distinguished name", 
      "type": "string"
    }, 
    "domain_id": {
      "description": "Domain ID this directory group belongs to.", 
      "required": true, 
      "title": "Domain id", 
      "type": "string"
    }, 
    "domain_sync_node_id": {
      "description": "Domain sync node under which this directory group is located.", 
      "required": true, 
      "title": "Domain synchronization root node id", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "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.", 
      "required": true, 
      "title": "Directory group resource type for this domain", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DirectoryGroupListResults (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DirectoryGroupListResults", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryGroup"+
      }, 
      "required": true, 
      "title": "Directory group list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DirectoryGroupMember (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DirectoryGroupMember", 
  "module_id": "ManagerNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "group_distinguished_name": {
      "description": "Directory group distinguished name this group member belongs to.", 
      "required": true, 
      "title": "Group distinguished name", 
      "type": "string"
    }, 
    "group_id": {
      "description": "Directory group id this group member belongs to", 
      "required": true, 
      "title": "Group idnetifier", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "member_group_distinguished_name": {
      "description": "Directory group name this group member owns", 
      "required": true, 
      "title": "Member group distinguished name", 
      "type": "string"
    }, 
    "member_group_id": {
      "description": "Directory group id this group member owns", 
      "required": true, 
      "title": "Member group idnetifier", 
      "type": "string"
    }, 
    "nested": {
      "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.", 
      "required": true, 
      "title": "Nesting flag", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DirectoryGroupMemberListResults (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DirectoryGroupMemberListResults", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryGroupMember"+
      }, 
      "required": true, 
      "title": "Directory group member list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DirectoryLdapServer (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DirectoryLdapServer", 
  "module_id": "ManagerNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Whether this directory LDAP server is enabled or not.", 
      "required": false, 
      "title": "Ldap server enable flag", 
      "type": "boolean"
    }, 
    "host": {
      "description": "Directory LDAP server DNS host name or ip address which is reachable by NSX manager to be connected and do object synchronization.", 
      "format": "ip-or-hostname", 
      "required": true, 
      "title": "Ldap server host name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "password": {
      "description": "Directory LDAP server connection password.", 
      "required": true, 
      "title": "Ldap server password", 
      "type": "string"
    }, 
    "port": {
      "default": 389, 
      "description": "Directory LDAP server connection TCP/UDP port.", 
      "max": 65535, 
      "min": 1, 
      "required": false, 
      "title": "Ldap server TCP/UDP port", 
      "type": "integer"
    }, 
    "protocol": {
      "default": "LDAP", 
      "description": "Directory LDAP server connection protocol which is either LDAP or LDAPS.", 
      "enum": [
        "LDAP", 
        "LDAPS"
      ], 
      "required": false, 
      "title": "Ldap server protocol", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "thumbprint": {
      "description": "Directory LDAP server certificate thumbprint used in secure LDAPS connection.", 
      "required": false, 
      "title": "Ldap server certificate thumbprint using SHA-256 algorithm", 
      "type": "string"
    }, 
    "username": {
      "description": "Directory LDAP server connection user name.", 
      "required": true, 
      "title": "Ldap server username", 
      "type": "string"
    }
  }, 
  "title": "Ldap Server of Directory Domain", 
  "type": "object"
}

DirectoryLdapServerListResults (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DirectoryLdapServerListResults", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DirectoryLdapServer"+
      }, 
      "maxItems": 50, 
      "required": true, 
      "title": "List of Directory Domain Ldap Servers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Directory Domain LDAP servers", 
  "type": "object"
}

DirectorySearchPattern (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DirectorySearchPattern", 
  "module_id": "ManagerNode", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "pattern": {
      "description": "Search pattern is a substring match pattern only which the target entity contains", 
      "required": true, 
      "title": "Name search pattern", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Searching domain entities using a matching pattern", 
  "type": "object"
}

DiscoveredNode (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource"+
  }, 
  "id": "DiscoveredNode", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "certificate": {
      "required": false, 
      "title": "Certificate of the discovered node", 
      "type": "string"
    }, 
    "cm_local_id": {
      "readonly": true, 
      "required": true, 
      "title": "Local Id of the discovered node in the Compute Manager", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Display name of discovered node", 
      "type": "string"
    }, 
    "external_id": {
      "readonly": true, 
      "required": true, 
      "title": "External id of the discovered node, ex. a mo-ref from VC", 
      "type": "string"
    }, 
    "hardware_id": {
      "description": "Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx.", 
      "readonly": true, 
      "required": false, 
      "title": "Hardware Id of the discovered node", 
      "type": "string"
    }, 
    "ip_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "IP Addresses of the the discovered node.", 
      "type": "array"
    }, 
    "node_type": {
      "readonly": true, 
      "required": true, 
      "title": "Discovered Node type like Host", 
      "type": "string"
    }, 
    "origin_id": {
      "readonly": true, 
      "required": true, 
      "title": "Id of the compute manager from where this node was discovered", 
      "type": "string"
    }, 
    "origin_properties": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Key-Value map of additional specific properties of discovered\nnode in the Compute Manager\n", 
      "type": "array"
    }, 
    "os_type": {
      "readonly": true, 
      "required": false, 
      "title": "OS type of the discovered node", 
      "type": "string"
    }, 
    "os_version": {
      "readonly": true, 
      "required": false, 
      "title": "OS version of the discovered node", 
      "type": "string"
    }, 
    "parent_compute_collection": {
      "readonly": true, 
      "required": false, 
      "title": "External id of the compute collection to which this node belongs", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "stateless": {
      "description": "The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true.", 
      "readonly": true, 
      "required": false, 
      "title": "Specifies whether host is stateless", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DiscoveredNodeInterfaceProperties (type) 

{
  "additionalProperties": false, 
  "description": "Network interface properties of discovered node", 
  "id": "DiscoveredNodeInterfaceProperties", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "connected_switch": {
      "description": "Switch name which is connected to nic, switch can be opaque, proxyHostSwitch or virtual", 
      "title": "Connected switch", 
      "type": "string"
    }, 
    "interface_id": {
      "description": "Id of the network interface", 
      "title": "Interface ID", 
      "type": "string"
    }, 
    "physical_address": {
      "$ref": "MACAddress"+, 
      "description": "Mac address of the interface", 
      "title": "Interface MAC address"
    }
  }, 
  "title": "Discovered node network interface properties", 
  "type": "object"
}

DiscoveredNodeListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DiscoveredNodeListRequestParameters", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "cm_local_id": {
      "required": false, 
      "title": "Local Id of the discovered node in the Compute Manager", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "display_name": {
      "required": false, 
      "title": "Display name of discovered node", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "External id of the discovered node, ex. a mo-ref from VC", 
      "type": "string"
    }, 
    "has_parent": {
      "enum": [
        "true", 
        "false"
      ], 
      "required": false, 
      "title": "Discovered node has a parent compute collection or is a standalone host", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_address": {
      "required": false, 
      "title": "IP address of the discovered node", 
      "type": "string"
    }, 
    "node_id": {
      "required": false, 
      "title": "Id of the fabric node created from the discovered node", 
      "type": "string"
    }, 
    "node_type": {
      "required": false, 
      "title": "Discovered Node type like HostNode", 
      "type": "string"
    }, 
    "origin_id": {
      "required": false, 
      "title": "Id of the compute manager from where this node was discovered", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "parent_compute_collection": {
      "required": false, 
      "title": "External id of the compute collection to which this node belongs", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Discovered Node list parameters", 
  "type": "object"
}

DiscoveredNodeListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DiscoveredNodeListResult", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DiscoveredNode"+
      }, 
      "required": true, 
      "title": "Discovered Node list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Discovered Node list result", 
  "type": "object"
}

DiscoveredNodeNetworkInterfaces (type) 

{
  "description": "All the network interfaces of the discovered node", 
  "id": "DiscoveredNodeNetworkInterfaces", 
  "module_id": "InventoryCmObj", 
  "properties": {
    "discovered_node_id": {
      "description": "Id of the discovered node", 
      "required": true, 
      "title": "Discovered node Id", 
      "type": "string"
    }, 
    "network_interfaces": {
      "description": "Network interfaces of the node", 
      "items": {
        "$ref": "DiscoveredNodeInterfaceProperties"+
      }, 
      "required": false, 
      "title": "Discovered Node interfaces", 
      "type": "array"
    }
  }, 
  "title": "Discovered node network interfaces", 
  "type": "object"
}

DiscoveredResource (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "DiscoveredResource", 
  "module_id": "Common", 
  "polymorphic-type-descriptor": {
    "property-name": "resource_type"
  }, 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base class for resources that are discovered and automatically updated", 
  "type": "object"
}

DnsForwarder (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "DnsForwarder", 
  "module_id": "DnsForwarder", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "cache_size": {
      "default": 1024, 
      "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", 
      "maximum": 16777216, 
      "minimum": 1, 
      "required": false, 
      "title": "Cache size in KB", 
      "type": "int"
    }, 
    "conditional_forwarders": {
      "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", 
      "items": {
        "$ref": "ConditionalForwarderZone"+
      }, 
      "maxItems": 5, 
      "required": false, 
      "title": "Conditional zone forwarders", 
      "type": "array"
    }, 
    "default_forwarder": {
      "$ref": "ForwarderZone"+, 
      "description": "The default zone forwarder that catches all other domain names except\nthose matched by conditional forwarder zone.\n", 
      "required": true, 
      "title": "Default zone forwarder"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "listener_ip": {
      "$ref": "IPv4Address"+, 
      "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", 
      "required": true, 
      "title": "Listener ip address"
    }, 
    "log_level": {
      "default": "INFO", 
      "enum": [
        "DEBUG", 
        "INFO", 
        "WARNING", 
        "ERROR", 
        "FATAL"
      ], 
      "required": false, 
      "title": "Log level of the dns forwarder", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "Specify the LogicalRouter where the DnsForwarder runs. The HA mode\nof the hosting LogicalRouter must be Active/Standby.\n", 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

DnsForwarderListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DnsForwarderListResult", 
  "module_id": "DnsForwarder", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "DnsForwarder"+
      }, 
      "required": true, 
      "title": "Paginated list of dns forwarders", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

DnsSettings (type) 

{
  "description": "Stores Azure gateway DNS settings like dns_mode and dns_list.\n", 
  "id": "DnsSettings", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "dns_list": {
      "description": "The is a list of nameserver ipv4 addresses that will be used by the\npublic cloud gateway. DNS will use these nameserver(s) if the\ncloud_dns_mode is set to PRECONFIGURED.\n", 
      "items": {
        "format": "ipv4", 
        "type": "string"
      }, 
      "required": false, 
      "title": "List of nameserver(s)", 
      "type": "array"
    }, 
    "dns_mode": {
      "default": "DHCP", 
      "description": "DHCP: Obtain nameserver(s) from DHCP.\nPRECONFIGURED: User supplies list of nameserver(s).\nCLOUD: Use cloud provider DNS.\n", 
      "enum": [
        "DHCP", 
        "PRECONFIGURED", 
        "CLOUD"
      ], 
      "required": false, 
      "title": "DNS mode", 
      "type": "string"
    }
  }, 
  "title": "DNS settings", 
  "type": "object"
}

DonutConfiguration (type) 

{
  "additionalProperties": false, 
  "description": "Represents configuration of a Donut", 
  "extends": {
    "$ref": "WidgetConfiguration"+
  }, 
  "id": "DonutConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "DonutConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "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.", 
      "items": {
        "$ref": "Datasource"+
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_count": {
      "default": true, 
      "description": "If true, displays the count of entities in the donut", 
      "title": "Show or hide the count of entities", 
      "type": "boolean"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "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.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "footer": {
      "$ref": "Footer"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label"+, 
      "description": "Displayed at the middle of the donut, by default. It labels the entities of donut.", 
      "title": "Label of the Donut Configuration"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "sections": {
      "decription": "High level logical grouping of portions or segments of donut.", 
      "items": {
        "$ref": "DonutSection"+
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Sections", 
      "type": "array"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Donut Configuration", 
  "type": "object"
}

DonutPart (type) 

{
  "additionalProperties": false, 
  "description": "Represents an entity or portion to be plotted on a donut or stats chart.", 
  "id": "DonutPart", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "field": {
      "description": "A numerical value that represents the portion or entity of the donut or stats chart.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Value of the portion or entity of donut or stats chart", 
      "type": "string"
    }, 
    "label": {
      "$ref": "Label"+, 
      "description": "If a section 'template' holds this donut or stats part, then the label is auto-generated from the fetched field values after applying the template.", 
      "title": "Label of the portion or entity of donut or stats chart"
    }, 
    "render_configuration": {
      "description": "Additional rendering or conditional evaluation of the field values to be performed, if any.", 
      "items": {
        "$ref": "RenderConfiguration"+
      }, 
      "minItems": 0, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the portion.", 
      "items": {
        "$ref": "Tooltip"+
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }
  }, 
  "title": "Portion of a donut or stats chart", 
  "type": "object"
}

DonutSection (type) 

{
  "additionalProperties": false, 
  "description": "Represents high level logical grouping of portions or segments of a donut / stats chart.", 
  "id": "DonutSection", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "parts": {
      "description": "Array of portions or parts of the donut or stats chart.", 
      "items": {
        "$ref": "DonutPart"+
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Parts of a donut / stats chart", 
      "type": "array"
    }, 
    "row_list_field": {
      "description": "Field of the root of the api result set for forming parts.", 
      "maxLength": 1024, 
      "title": "Field from which parts of the donut or stats chart are formed", 
      "type": "string"
    }, 
    "template": {
      "default": false, 
      "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", 
      "type": "boolean"
    }
  }, 
  "title": "Section of a donut or stats chart", 
  "type": "object"
}

Dscp (type) 

{
  "description": "Dscp value is ignored in case of 'TRUSTED' DscpMode.", 
  "id": "Dscp", 
  "module_id": "QosSwitchingProfile", 
  "properties": {
    "mode": {
      "$ref": "DscpMode"+
    }, 
    "priority": {
      "default": 0, 
      "maximum": 63, 
      "minimum": 0, 
      "title": "Internal Forwarding Priority", 
      "type": "int"
    }
  }, 
  "required": true, 
  "title": "One of Quality-of-Service or Encapsulated-Remote-Switched-Port-Analyzer", 
  "type": "object"
}

DscpMode (type) 

{
  "default": "TRUSTED", 
  "enum": [
    "TRUSTED", 
    "UNTRUSTED"
  ], 
  "id": "DscpMode", 
  "module_id": "QosSwitchingProfile", 
  "title": "Trust settings", 
  "type": "string"
}

EULAAcceptance (type) 

{
  "additionalProperties": false, 
  "description": "Indicate the status of End User License Agreement acceptance", 
  "id": "EULAAcceptance", 
  "module_id": "EULA", 
  "properties": {
    "acceptance": {
      "required": true, 
      "title": "End User License Agreement acceptance status", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

EULAContent (type) 

{
  "additionalProperties": false, 
  "description": "End User License Agreement content", 
  "id": "EULAContent", 
  "module_id": "EULA", 
  "properties": {
    "content": {
      "required": true, 
      "sensitive": true, 
      "title": "End User License Agreement content", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EULAOutputFormatRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "Indicate output format of End User License Agreement content", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "EULAOutputFormatRequestParameters", 
  "module_id": "EULA", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "format": {
      "title": "End User License Agreement content output format", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeCluster (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "EdgeCluster", 
  "module_id": "EdgeClusters", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "cluster_profile_bindings": {
      "items": {
        "$ref": "ClusterProfileTypeIdEntry"+
      }, 
      "required": false, 
      "title": "Edge cluster profile bindings", 
      "type": "array"
    }, 
    "deployment_type": {
      "$ref": "EdgeDeploymentType"+, 
      "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", 
      "readonly": true, 
      "required": false, 
      "title": "Edge cluster deployment type"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "member_node_type": {
      "$ref": "EdgeClusterNodeType"+, 
      "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", 
      "readonly": true, 
      "required": false, 
      "title": "Node type of the cluster members"
    }, 
    "members": {
      "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", 
      "items": {
        "$ref": "EdgeClusterMember"+
      }, 
      "required": false, 
      "title": "Edge cluster members", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EdgeClusterListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "EdgeClusterListResult", 
  "module_id": "EdgeClusters", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EdgeCluster"+
      }, 
      "required": true, 
      "title": "Edge cluster list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeClusterMember (type) 

{
  "additionalProperties": false, 
  "id": "EdgeClusterMember", 
  "module_id": "EdgeClusters", 
  "properties": {
    "description": {
      "description": "description of edge cluster member", 
      "required": false, 
      "title": "description of edge cluster member", 
      "type": "string"
    }, 
    "display_name": {
      "description": "display name of edge cluster member", 
      "required": false, 
      "title": "display name of edge cluster member", 
      "type": "string"
    }, 
    "member_index": {
      "description": "System generated index for cluster member", 
      "readonly": true, 
      "required": false, 
      "title": "System generated index for cluster member", 
      "type": "int"
    }, 
    "transport_node_id": {
      "description": "Identifier of the transport node backed by an Edge node", 
      "required": true, 
      "title": "UUID of edge transport node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeClusterMemberAllocationPool (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "id": "EdgeClusterMemberAllocationPool", 
  "module_id": "LogicalRouter", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "allocation_pool_type"
  }, 
  "properties": {
    "allocation_pool_type": {
      "$ref": "AllocationPoolType"+, 
      "required": true
    }
  }, 
  "type": "object"
}

EdgeClusterMemberAllocationProfile (type) 

{
  "additionalProperties": false, 
  "id": "EdgeClusterMemberAllocationProfile", 
  "module_id": "LogicalRouter", 
  "properties": {
    "allocation_pool": {
      "$ref": "EdgeClusterMemberAllocationPool"+, 
      "description": "Logical router allocation can be tracked for specific services and\nservices may have their own hard limits and allocation sizes. For\nexample load balancer pool should be specified if load balancer\nservice will be attached to logical router.\n", 
      "required": false, 
      "title": "Edge Cluster Member Allocation Pool for logical router"
    }
  }, 
  "type": "object"
}

EdgeClusterMemberListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "EdgeClusterMemberListResult", 
  "module_id": "EdgeClusters", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "EdgeClusterMember"+
      }, 
      "required": true, 
      "title": "edge cluster member list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EdgeClusterNodeType (type) 

{
  "enum": [
    "EDGE_NODE", 
    "PUBLIC_CLOUD_GATEWAY_NODE", 
    "UNKNOWN"
  ], 
  "id": "EdgeClusterNodeType", 
  "module_id": "EdgeCommonTypes", 
  "title": "Supported edge cluster node type.", 
  "type": "string"
}

EdgeDeploymentType (type) 

{
  "enum": [
    "VIRTUAL_MACHINE", 
    "PHYSICAL_MACHINE", 
    "UNKNOWN"
  ], 
  "id": "EdgeDeploymentType", 
  "module_id": "EdgeCommonTypes", 
  "title": "Supported edge deployment type.", 
  "type": "string"
}

EdgeFormFactor (type) 

{
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "LARGE"
  ], 
  "id": "EdgeFormFactor", 
  "module_id": "EdgeCommonTypes", 
  "title": "Supported edge form factor.", 
  "type": "string"
}

EdgeHighAvailabilityProfile (type) 

{
  "extends": {
    "$ref": "ClusterProfile"+
  }, 
  "id": "EdgeHighAvailabilityProfile", 
  "module_id": "EdgeHighAvailabilityProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EdgeHighAvailabilityProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bfd_allowed_hops": {
      "default": 255, 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "BFD allowed hops", 
      "type": "integer"
    }, 
    "bfd_declare_dead_multiple": {
      "default": 3, 
      "maximum": 16, 
      "minimum": 2, 
      "required": false, 
      "title": "Number of times a packet is missed before BFD declares the neighbor down.", 
      "type": "integer"
    }, 
    "bfd_probe_interval": {
      "default": 1000, 
      "maximum": 60000, 
      "minimum": 300, 
      "required": false, 
      "title": "the time interval (in millisec) between probe packets for heartbeat purpose", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ClusterProfileType"+, 
      "help_summary": "The cluster profile type.", 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for BFD HA cluster setting", 
  "type": "object"
}

EdgeNode (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Node"+
  }, 
  "id": "EdgeNode", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EdgeNode"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allocation_list": {
      "description": "List of logical router ids to which this edge node is allocated.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Allocation list", 
      "type": "array"
    }, 
    "deployment_config": {
      "$ref": "EdgeNodeDeploymentConfig"+, 
      "description": "When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE\nwill be deployed and registered with MP.\n", 
      "required": false, 
      "title": "Config for automatic deployment of edge node virtual machine."
    }, 
    "deployment_type": {
      "$ref": "EdgeDeploymentType"+, 
      "readonly": true, 
      "required": false
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_ip_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Discovered IP Addresses of the fabric node, version 4 or 6", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "ID of the Node maintained on the Node and used to recognize the Node", 
      "type": "string"
    }, 
    "fqdn": {
      "readonly": true, 
      "required": false, 
      "title": "Fully qualified domain name of the fabric node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "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", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": false, 
      "title": "IP Addresses of the Node, version 4 or 6", 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'", 
      "required": true, 
      "title": "Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EdgeNodeDeploymentConfig (type) 

{
  "additionalProperties": false, 
  "id": "EdgeNodeDeploymentConfig", 
  "module_id": "FabricNode", 
  "properties": {
    "form_factor": {
      "$ref": "EdgeFormFactor"+, 
      "default": "MEDIUM", 
      "required": false
    }, 
    "node_user_settings": {
      "$ref": "NodeUserSettings"+, 
      "description": "Username and password settings for the node.\nNote - these settings will be honored only during node deployment.\nPost deployment, CLI must be used for changing the user settings, changes to these parameters will not have any effect.\n", 
      "required": true, 
      "title": "Node user settings"
    }, 
    "vm_deployment_config": {
      "$ref": "DeploymentConfig"+, 
      "required": true
    }
  }, 
  "type": "object"
}

EdgeUpgradeStatus (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus"+
  }, 
  "id": "EdgeUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }
  }, 
  "title": "Status of edge upgrade", 
  "type": "object"
}

EffectiveIPAddressMemberListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "EffectiveIPAddressMemberListResult", 
  "module_id": "NSGroup", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPElement"+
      }, 
      "required": true, 
      "title": "Paged Collection of effective ip addresses for the given NSGroup", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EffectiveMemberResourceListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "EffectiveMemberResourceListResult", 
  "module_id": "NSGroup", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ResourceReference"+, 
        "title": "effective members resource list results"
      }, 
      "required": true, 
      "title": "Paged Collection of resources which are the effective members of an NSGroup.", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

EgressRateShaper (type) 

{
  "extends": {
    "$ref": "QosBaseRateShaper"+
  }, 
  "id": "EgressRateShaper", 
  "module_id": "QosSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EgressRateShaper"
  }, 
  "properties": {
    "average_bandwidth_mbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Average bandwidth in Mb/s", 
      "type": "int"
    }, 
    "burst_size_bytes": {
      "default": 0, 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth_mbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Peak bandwidth in Mb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateShaper", 
      "enum": [
        "IngressRateShaper", 
        "IngressBroadcastRateShaper", 
        "EgressRateShaper"
      ], 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies egress rate properties in Mb/s", 
  "type": "object"
}

EmbeddedResource (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "EmbeddedResource", 
  "module_id": "Common", 
  "polymorphic-type-descriptor": {
    "property-name": "resource_type"
  }, 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink"+, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the resource", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }
  }, 
  "title": "Base class for resources that are embedded in other resources", 
  "type": "object"
}

EncapsulationType (type) 

{
  "additionalProperties": false, 
  "description": "You can choose the encapsulation type of the mirroring, now we support\nGRE, ERSPAN II and ERSPAN III.\n", 
  "enum": [
    "GRE", 
    "ERSPAN_TWO", 
    "ERSPAN_THREE"
  ], 
  "id": "EncapsulationType", 
  "module_id": "PortMirroring", 
  "title": "Encapsulation type for L3PortMirrorSession", 
  "type": "string"
}

Endpoint (type) 

{
  "description": "An Endpoint object is part of HostSwitch configuration in TransportNode", 
  "id": "Endpoint", 
  "module_id": "TransportNode", 
  "properties": {
    "default_gateway": {
      "$ref": "IPAddress"+, 
      "readonly": true, 
      "title": "Gateway IP"
    }, 
    "device_name": {
      "readonly": true, 
      "title": "Name of the virtual tunnel endpoint", 
      "type": "string"
    }, 
    "ip": {
      "$ref": "IPAddress"+, 
      "description": "Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool.", 
      "readonly": true, 
      "title": "IP Address of this virtual tunnel endpoint"
    }, 
    "label": {
      "readonly": true, 
      "required": false, 
      "title": "Unique label for this Endpoint", 
      "type": "int"
    }, 
    "mac": {
      "$ref": "MACAddress"+, 
      "readonly": true, 
      "title": "MAC address"
    }, 
    "subnet_mask": {
      "$ref": "IPAddress"+, 
      "readonly": true, 
      "title": "Subnet mask"
    }
  }, 
  "title": "Tunnel endpoint configuration", 
  "type": "object"
}

EpochMsTimestamp (type) 

{
  "id": "EpochMsTimestamp", 
  "module_id": "Common", 
  "title": "Timestamp in milliseconds since epoch", 
  "type": "integer"
}

ErrorResolverInfo (type) 

{
  "additionalProperties": false, 
  "description": "Metadata related to a given error_id", 
  "id": "ErrorResolverInfo", 
  "module_id": "ErrorResolver", 
  "properties": {
    "error_id": {
      "required": true, 
      "title": "The error id for which metadata information is needed", 
      "type": "integer"
    }, 
    "resolver_present": {
      "required": true, 
      "title": "Indicates whether there is a resolver associated with the error or not", 
      "type": "boolean"
    }, 
    "user_metadata": {
      "$ref": "ErrorResolverUserMetadata"+, 
      "required": false, 
      "title": "User supplied metadata that might be required by the resolver"
    }
  }, 
  "type": "object"
}

ErrorResolverInfoList (type) 

{
  "additionalProperties": false, 
  "id": "ErrorResolverInfoList", 
  "module_id": "ErrorResolver", 
  "properties": {
    "results": {
      "items": {
        "$ref": "ErrorResolverInfo"+
      }, 
      "required": true, 
      "title": "ErrorResolverInfo list", 
      "type": "array"
    }
  }, 
  "title": "Collection of all registered ErrorResolverInfo", 
  "type": "object"
}

ErrorResolverMetadata (type) 

{
  "additionalProperties": false, 
  "description": "Error along with its metadata", 
  "id": "ErrorResolverMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "entity_id": {
      "required": true, 
      "title": "The entity/node UUID where the error has occurred.", 
      "type": "string"
    }, 
    "error_id": {
      "required": true, 
      "title": "The error id as reported by the entity where the error occurred.", 
      "type": "integer"
    }, 
    "system_metadata": {
      "$ref": "ErrorResolverSystemMetadata"+, 
      "required": false, 
      "title": "This can come from some external system like syslog collector"
    }, 
    "user_metadata": {
      "$ref": "ErrorResolverUserMetadata"+, 
      "required": false, 
      "title": "User supplied metadata that might be required by the resolver"
    }
  }, 
  "type": "object"
}

ErrorResolverMetadataList (type) 

{
  "additionalProperties": false, 
  "description": "List of errors with their metadata", 
  "id": "ErrorResolverMetadataList", 
  "module_id": "ErrorResolver", 
  "properties": {
    "errors": {
      "items": {
        "$ref": "ErrorResolverMetadata"+
      }, 
      "required": true, 
      "title": "List of errors with their corresponding metadata.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ErrorResolverSystemMetadata (type) 

{
  "additionalProperties": false, 
  "description": "Metadata fetched from an external system like Syslog or LogInsight.", 
  "id": "ErrorResolverSystemMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "value": {
      "required": false, 
      "title": "The value fetched from another system", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ErrorResolverUserInputData (type) 

{
  "additionalProperties": false, 
  "description": "Corresponds to one property entered by the user", 
  "id": "ErrorResolverUserInputData", 
  "module_id": "ErrorResolver", 
  "properties": {
    "data_type": {
      "enum": [
        "TEXT", 
        "NUMBER", 
        "PASSWORD"
      ], 
      "required": true, 
      "title": "The datatype of the given property. Useful for data validation", 
      "type": "string"
    }, 
    "property_name": {
      "required": true, 
      "title": "Name of the property supplied by the user", 
      "type": "string"
    }, 
    "property_value": {
      "required": false, 
      "title": "The value associated with the above property", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ErrorResolverUserMetadata (type) 

{
  "additionalProperties": false, 
  "description": "User supplied metadata needed for resolving errors", 
  "id": "ErrorResolverUserMetadata", 
  "module_id": "ErrorResolver", 
  "properties": {
    "user_input_list": {
      "items": {
        "$ref": "ErrorResolverUserInputData"+
      }, 
      "required": false, 
      "title": "List of user supplied input data.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

EtherTypeNSService (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "EtherTypeNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EtherTypeNSService"
  }, 
  "properties": {
    "ether_type": {
      "required": true, 
      "title": "Type of the encapsulated protocol", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }
  }, 
  "title": "An NSService element that represents an ethertype protocol", 
  "type": "object"
}

ExcludeList (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ExcludeList", 
  "module_id": "ExcludeList", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "members": {
      "description": "List of the members in the exclude list", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": true, 
      "title": "ExcludeList member list", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ExtraConfig (type) 

{
  "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", 
  "id": "ExtraConfig", 
  "module_id": "Switching", 
  "properties": {
    "config_pair": {
      "$ref": "KeyValuePair"+, 
      "required": true, 
      "title": "Key value pair in string for the configuration"
    }
  }, 
  "title": "Vendor specific configuration on logical switch or logical port", 
  "type": "object"
}

ExtraConfigHostSwitchProfile (type) 

{
  "extends": {
    "$ref": "BaseHostSwitchProfile"+
  }, 
  "id": "ExtraConfigHostSwitchProfile", 
  "module_id": "ExtraConfigHostSwitchProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ExtraConfigHostSwitchProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "extra_configs": {
      "items": {
        "$ref": "ExtraConfig"+
      }, 
      "required": false, 
      "title": "list of extra configs", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "HostSwitchProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for extra configs in host switch", 
  "type": "object"
}

FabricModule (type) 

{
  "additionalProperties": false, 
  "description": "Fabric module contains list of deployment specs and current version.\nEach deployment spec is a different version of same fabric module.\nIf fabric module have two deployment specs or say two different versions then\ncurrent version will specify which version needs to be installed.\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "FabricModule", 
  "module_id": "HostPrepServiceFabric", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "current_version": {
      "required": true, 
      "title": "current version on for the host prep fabric module.", 
      "type": "string"
    }, 
    "custom_data": {
      "description": "Slot for storing consumer data (fabric module's specific\ndata common across all the realizations of the fabric\nmodule)\n", 
      "items": {
        "$ref": "StringMapEntry"+
      }, 
      "required": false, 
      "title": "Customer data", 
      "type": "array"
    }, 
    "deployment_specs": {
      "items": {
        "$ref": "DeploymentSpec"+
      }, 
      "required": true, 
      "title": "List of deployment specs", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fabric_module_name": {
      "required": true, 
      "title": "Name of the fabric module", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "source_authentication_mode": {
      "default": "NO_AUTHENTICATION", 
      "description": "This enum specifies the authentication supported\nat source i.e. for downloading VM.\nIf this attribute is not provided, then NO_AUTHENTICATION\nwill be considered.\n", 
      "enum": [
        "NO_AUTHENTICATION", 
        "BASIC_AUTHENTICATION", 
        "MARKET_PLACE"
      ], 
      "required": false, 
      "title": "Authentication needed by fabric module at source", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Fabric Module contains list of deployment specs and current version.", 
  "type": "object"
}

FabricModuleListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "FabricModuleListRequestParameters", 
  "module_id": "HostPrepServiceFabric", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "fabric_module_name": {
      "enum": [
        "hostprep"
      ], 
      "required": false, 
      "title": "name of fabric module.", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Request parameters for read host fabric module.", 
  "type": "object"
}

FabricModuleListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "FabricModuleListResult", 
  "module_id": "HostPrepServiceFabric", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FabricModule"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Fabric Module list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Fabric Module list result", 
  "type": "object"
}

FailedNodeSupportBundleResult (type) 

{
  "additionalProperties": false, 
  "id": "FailedNodeSupportBundleResult", 
  "properties": {
    "error_code": {
      "readonly": true, 
      "required": true, 
      "title": "Error code", 
      "type": "string"
    }, 
    "error_message": {
      "readonly": true, 
      "required": true, 
      "title": "Error message", 
      "type": "string"
    }, 
    "node_display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Display name of node", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "UUID of node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FeatureAccess (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "FeatureAccess", 
  "module_id": "AAA", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "readonly": true, 
      "required": true, 
      "title": "Feature enabled or not", 
      "type": "boolean"
    }, 
    "feature": {
      "readonly": true, 
      "required": false, 
      "title": "Feature", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "information": {
      "items": {
        "$ref": "FeatureInfo"+
      }, 
      "required": false, 
      "title": "Feature Info", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Feature access", 
  "type": "object"
}

FeatureAccessListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "FeatureAccessListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FeatureAccess"+
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FeatureInfo (type) 

{
  "id": "FeatureInfo", 
  "module_id": "AAA", 
  "properties": {
    "info": {
      "readonly": true, 
      "required": true, 
      "title": "Info", 
      "type": "string"
    }
  }, 
  "title": "Feature Info", 
  "type": "object"
}

FeaturePermission (type) 

{
  "id": "FeaturePermission", 
  "module_id": "AAA", 
  "properties": {
    "feature": {
      "readonly": true, 
      "required": true, 
      "title": "Feature Name", 
      "type": "string"
    }, 
    "permission": {
      "enum": [
        "crud", 
        "read", 
        "execute", 
        "none"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Permission", 
      "type": "string"
    }
  }, 
  "title": "Feature Permission", 
  "type": "object"
}

FeaturePermissionListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "FeaturePermissionListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FeaturePermission"+
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FeatureStackCollectionConfiguration (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "FeatureStackCollectionConfiguration", 
  "module_id": "AggSvcDataCollectionConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "client_type_collection_configurations": {
      "description": "The set of client type data collection configurations", 
      "items": {
        "$ref": "ClientTypeCollectionConfiguration"+
      }, 
      "title": "Client type collection configurations", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "feature_stack_name": {
      "description": "The name of the feature stack", 
      "required": true, 
      "title": "Feature stack name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "HPM feature stack data collection frequency configuration", 
  "type": "object"
}

FeatureStackCollectionConfigurationList (type) 

{
  "id": "FeatureStackCollectionConfigurationList", 
  "module_id": "AggSvcDataCollectionConfig", 
  "properties": {
    "results": {
      "description": "The complete set of feature stack data collection configurations", 
      "items": {
        "$ref": "FeatureStackCollectionConfiguration"+
      }, 
      "readonly": true, 
      "title": "Feature stack configurations", 
      "type": "array"
    }
  }, 
  "title": "Feature stack collection configuration list result", 
  "type": "object"
}

FeatureUsage (type) 

{
  "description": "feature usage result item", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "FeatureUsage", 
  "module_id": "License", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "capacity_usage": {
      "items": {
        "$ref": "CapacityUsage"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Capacity Usage List", 
      "type": "array"
    }, 
    "feature": {
      "readonly": true, 
      "title": "name of the feature", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FeatureUsageCsvRecord (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "FeatureUsageCsvRecord", 
  "module_id": "License", 
  "properties": {
    "cpu_usage_count": {
      "readonly": true, 
      "title": "count of number of cpu sockets used by this feature", 
      "type": "integer"
    }, 
    "feature": {
      "readonly": true, 
      "title": "name of the feature", 
      "type": "string"
    }, 
    "vcpu_usage_count": {
      "readonly": true, 
      "title": "count of number of vcpus of public cloud VMs", 
      "type": "integer"
    }, 
    "vm_usage_count": {
      "readonly": true, 
      "title": "count of number of vms used by this feature", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

FeatureUsageList (type) 

{
  "description": "list of feature usage items", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "FeatureUsageList", 
  "module_id": "License", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "feature_usage_info": {
      "items": {
        "$ref": "FeatureUsage"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Feature Usage List", 
      "type": "array"
    }
  }, 
  "type": "object"
}

FeatureUsageListInCsvFormat (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "FeatureUsageListInCsvFormat", 
  "module_id": "License", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has\nnever updated the data.\n", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "FeatureUsageCsvRecord"+
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

FileHash (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "FileHash", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "hash_code": {
      "required": true, 
      "title": "Computed hash of file", 
      "type": "string"
    }, 
    "hash_type": {
      "enum": [
        "SHA1"
      ], 
      "required": true, 
      "title": "Algorithm used to compute the file's hash", 
      "type": "string"
    }, 
    "name": {
      "pattern": "^[^/]+$", 
      "required": true, 
      "title": "File name", 
      "type": "string"
    }
  }, 
  "title": "File hash code", 
  "type": "object"
}

FileProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "FileProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "created_epoch_ms": {
      "required": true, 
      "title": "File creation time in epoch milliseconds", 
      "type": "integer"
    }, 
    "modified_epoch_ms": {
      "required": true, 
      "title": "File modification time in epoch milliseconds", 
      "type": "integer"
    }, 
    "name": {
      "pattern": "^[^/]+$", 
      "required": true, 
      "title": "File name", 
      "type": "string"
    }, 
    "size": {
      "required": true, 
      "title": "Size of the file in bytes", 
      "type": "integer"
    }
  }, 
  "title": "File properties", 
  "type": "object"
}

FilePropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "FilePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FileProperties"+
      }, 
      "required": true, 
      "title": "File property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "File properties query results", 
  "type": "object"
}

FileThumbprint (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "FileThumbprint", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "name": {
      "pattern": "^[^/]+$", 
      "required": true, 
      "title": "File name", 
      "type": "string"
    }, 
    "sha1": {
      "required": true, 
      "title": "File's SHA1 thumbprint", 
      "type": "string"
    }, 
    "sha256": {
      "required": true, 
      "title": "File's SHA256 thumbprint", 
      "type": "string"
    }
  }, 
  "title": "File thumbprint", 
  "type": "object"
}

FileTransferAuthenticationScheme (type) 

{
  "additionalProperties": false, 
  "id": "FileTransferAuthenticationScheme", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "password": {
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "PASSWORD"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "pattern": "^([a-zA-Z][a-zA-Z0-9-.]*[a-zA-Z]\\\\\\){0,1}\\w[\\w.-]+$", 
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "title": "Remote server authentication details", 
  "type": "object"
}

FileTransferProtocol (type) 

{
  "additionalProperties": false, 
  "id": "FileTransferProtocol", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "authentication_scheme": {
      "$ref": "FileTransferAuthenticationScheme"+, 
      "required": true, 
      "title": "Scheme to authenticate if required"
    }, 
    "protocol_name": {
      "default": "sftp", 
      "enum": [
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "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", 
      "pattern": "^SHA256:.*$", 
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string", 
      "validation_msg_key": "com.vmware.nsx.validation.constraints.BackupRestore.fingerprint_pattern.message"
    }
  }, 
  "title": "Protocol to transfer backup file to remote server", 
  "type": "object"
}

FileUsageListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "FileUsageListParameters", 
  "module_id": "FileMonitor", 
  "properties": {
    "appliance_type": {
      "enum": [
        "MP", 
        "CCP", 
        "EDGE"
      ], 
      "required": false, 
      "title": "Type of appliance", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "File Usage list parameters", 
  "type": "object"
}

FilterRequest (type) 

{
  "additionalProperties": false, 
  "description": "Filter request parameters", 
  "id": "FilterRequest", 
  "module_id": "Search", 
  "properties": {
    "field_names": {
      "description": "Comma seperated fields to be filtered on", 
      "required": true, 
      "title": "Field Names", 
      "type": "string"
    }, 
    "value": {
      "description": "Filter value", 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "Filter request", 
  "type": "object"
}

FireWallServiceAssociationListResult (type) 

{
  "extends": {
    "$ref": "ServiceAssociationListResult"+
  }, 
  "id": "FireWallServiceAssociationListResult", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Firewall rule list result with pagination support.", 
      "items": {
        "$ref": "FirewallRule"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Firewall rule list result", 
      "type": "array"
    }, 
    "service_type": {
      "enum": [
        "FireWallServiceAssociationListResult", 
        "IpfixServiceAssociationListResult"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FirewallCategory (type) 

{
  "description": "Statistic category for the type of rules in a section, like Layer2 Distributed Firewall, Layer3 DFW.", 
  "enum": [
    "L2DFW", 
    "L3DFW"
  ], 
  "id": "FirewallCategory", 
  "module_id": "Firewall", 
  "readonly": true, 
  "required": false, 
  "title": "Firewall Category", 
  "type": "string"
}

FirewallContextType (type) 

{
  "description": "Types of firewall contexts.", 
  "enum": [
    "transport_nodes", 
    "logical_routers"
  ], 
  "id": "FirewallContextType", 
  "module_id": "FirewallStatus", 
  "title": "Firewall Context Type", 
  "type": "string"
}

FirewallListRequestParameters (type) 

{
  "description": "Pagination and Filtering parameters to get only a subset of sections/rules.", 
  "extends": {
    "$ref": "DSListRequestParameters"+
  }, 
  "id": "FirewallListRequestParameters", 
  "module_id": "Firewall", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type\n'FILTER' will ensure all criterias (sources, destinations, services,\nappliedtos) are matched. Type 'SEARCH' will match any of the given\ncriteria.\n", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "search_invalid_references": {
      "default": false, 
      "description": "Used in conjunction with filter_type to find invalid i.e. non nonexistent references in given criteria (sources, destinations, services, applied_tos).", 
      "required": false, 
      "title": "Return invalid references in results.", 
      "type": "boolean"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter list of sections/rules.", 
  "type": "object"
}

FirewallRule (type) 

{
  "extends": {
    "$ref": "DSRule"+
  }, 
  "id": "FirewallRule", 
  "module_id": "Firewall", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink"+, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "action": {
      "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).", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT", 
        "REDIRECT", 
        "DO_NOT_REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Action", 
      "type": "string"
    }, 
    "applied_tos": {
      "description": "List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of the destinations. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Destination List", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "Negation of the destination.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "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.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Rule direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable rule. Disabled will only be persisted but never provisioned/realized.", 
      "readonly": false, 
      "required": false, 
      "title": "Rule enable/disable flag", 
      "type": "boolean"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the resource", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "ip_protocol": {
      "default": "IPV4_IPV6", 
      "description": "Type of IP packet that should be matched while enforcing the rule.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "Flag to indicate whether rule is default.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "User notes specific to the rule.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Notes", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "maxLength": 32, 
      "readonly": false, 
      "required": false, 
      "title": "Tag", 
      "type": "string"
    }, 
    "section_id": {
      "description": "Section Id of the section to which this rule belongs to.", 
      "readonly": true, 
      "required": false, 
      "title": "Section Id", 
      "type": "string"
    }, 
    "services": {
      "description": "List of the services. Null will be treated as any.", 
      "items": {
        "$ref": "FirewallService"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Service List", 
      "type": "array"
    }, 
    "sources": {
      "description": "List of sources. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Source List", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "Negation of the source.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

FirewallRuleListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "FirewallRuleListResult", 
  "module_id": "Firewall", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Firewall rule list result with pagination support.", 
      "items": {
        "$ref": "FirewallRule"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Firewall rule list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FirewallSection (type) 

{
  "extends": {
    "$ref": "DSSection"+
  }, 
  "id": "FirewallSection", 
  "module_id": "Firewall", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "applied_tos": {
      "description": "List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "autoplumbed": {
      "default": false, 
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Tells if a section is auto-plumbed or not", 
      "type": "boolean"
    }, 
    "comments": {
      "description": "Comments for section lock/unlock.", 
      "readonly": true, 
      "required": false, 
      "title": "Section lock/unlock comments", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enforced_on": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Firewall Section Enforcement type", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Default section flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the section.", 
      "readonly": true, 
      "required": false, 
      "title": "Lock modified by user", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Section locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "Section locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Section is locked/unlocked.", 
      "readonly": true, 
      "required": false, 
      "title": "Section Locked", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "section_type": {
      "description": "Type of the rules which a section can contain. Only homogeneous sections are supported.", 
      "enum": [
        "LAYER2", 
        "LAYER3", 
        "L3REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Section Type", 
      "type": "string"
    }, 
    "stateful": {
      "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.", 
      "readonly": false, 
      "required": true, 
      "title": "Stateful nature of the distributed service rules in the section.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

FirewallSectionFilterParameters (type) 

{
  "description": "Pagination and Filtering parameters to get only a subset of sections.", 
  "extends": {
    "$ref": "FirewallListRequestParameters"+
  }, 
  "id": "FirewallSectionFilterParameters", 
  "module_id": "Firewall", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "enforced_on": {
      "$ref": "AttachmentTypeQueryString"+, 
      "description": "Used to filter out results based on enforcement point of the section. If this parameter is BRIDGEENDPOINT, then return firewall sections enfored on logical port with attachment type bridgeendpoint. For LOGICALROUTER, then firewall sections enforced on Logical Router are returned. For VIF, other firewall sections are returned. Other values are not supported.", 
      "required": false, 
      "title": "Limit result to sections having a specific kind of enforcement point"
    }, 
    "exclude_applied_to_type": {
      "$ref": "DSAppliedToType"+, 
      "description": "Used to filter out sections not having a specified AppliedTo target type. This parameter cannot be used along with include_applied_to_type parameter. Section filter only takes a single value for this param.", 
      "required": false, 
      "title": "Limit result to sections not having a specific AppliedTo type"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type\n'FILTER' will ensure all criterias (sources, destinations, services,\nappliedtos) are matched. Type 'SEARCH' will match any of the given\ncriteria.\n", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "include_applied_to_type": {
      "$ref": "DSAppliedToType"+, 
      "description": "Used to filter out results based on target type of a section's AppliedTo. Only sections with matching target type in its applied to will be returned. This parameter cannot be used along with exclude_applied_to_type parameter.Section filter only takes a single value for this param.", 
      "required": false, 
      "title": "Limit result to sections having a specific AppliedTo type"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "locked": {
      "description": "Used to filter out locked or unlocked sections.", 
      "required": false, 
      "title": "Limit results to sections which are locked/unlocked", 
      "type": "boolean"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "search_invalid_references": {
      "default": false, 
      "description": "Used in conjunction with filter_type to find invalid i.e. non nonexistent references in given criteria (sources, destinations, services, applied_tos).", 
      "required": false, 
      "title": "Return invalid references in results.", 
      "type": "boolean"
    }, 
    "search_scope": {
      "description": "This parameter can be used to limit the search scope to certain firewalls. It can be the value of an appliedTo of a bridge port firewall or an edge firewal. Results will include sections only from that bridge port firewall or edge firewall. For example, if the identifier of a bridge port is given, the search result will only contain the sections of that bridge port firewall. If the identifier of logical router is given, the search result will only contain the sections of that edge firewall.", 
      "required": false, 
      "title": "Limit result to sections of a specific enforcement point", 
      "type": "string"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "type": {
      "default": "LAYER3", 
      "description": "Section Type with values layer2 or layer3", 
      "enum": [
        "LAYER2", 
        "LAYER3"
      ], 
      "required": false, 
      "title": "Section Type", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter section from list of sections", 
  "type": "object"
}

FirewallSectionListResult (type) 

{
  "extends": {
    "$ref": "DSSectionListResult"+
  }, 
  "id": "FirewallSectionListResult", 
  "module_id": "Firewall", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of the firewall sections. The list has to be homogenous.", 
      "items": {
        "$ref": "FirewallSection"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Section list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FirewallSectionRuleList (type) 

{
  "extends": {
    "$ref": "FirewallSection"+
  }, 
  "id": "FirewallSectionRuleList", 
  "module_id": "Firewall", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "applied_tos": {
      "description": "List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "autoplumbed": {
      "default": false, 
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Tells if a section is auto-plumbed or not", 
      "type": "boolean"
    }, 
    "comments": {
      "description": "Comments for section lock/unlock.", 
      "readonly": true, 
      "required": false, 
      "title": "Section lock/unlock comments", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enforced_on": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Firewall Section Enforcement type", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Default section flag", 
      "type": "boolean"
    }, 
    "lock_modified_by": {
      "description": "ID of the user who last modified the lock for the section.", 
      "readonly": true, 
      "required": false, 
      "title": "Lock modified by user", 
      "type": "string"
    }, 
    "lock_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Section locked/unlocked time in epoch milliseconds.", 
      "readonly": true, 
      "required": false, 
      "title": "Section locked/unlocked time"
    }, 
    "locked": {
      "default": false, 
      "description": "Section is locked/unlocked.", 
      "readonly": true, 
      "required": false, 
      "title": "Section Locked", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "rules": {
      "description": "List of firewall rules in the section. Only homogenous rules are supported.", 
      "items": {
        "$ref": "FirewallRule"+
      }, 
      "maxItems": 1000, 
      "readonly": false, 
      "required": true, 
      "title": "List of the firewall rules", 
      "type": "array"
    }, 
    "section_type": {
      "description": "Type of the rules which a section can contain. Only homogeneous sections are supported.", 
      "enum": [
        "LAYER2", 
        "LAYER3", 
        "L3REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Section Type", 
      "type": "string"
    }, 
    "stateful": {
      "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.", 
      "readonly": false, 
      "required": true, 
      "title": "Stateful nature of the distributed service rules in the section.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

FirewallSectionState (type) 

{
  "extends": {
    "$ref": "DSSectionState"+
  }, 
  "id": "FirewallSectionState", 
  "module_id": "Firewall", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "revision_desired": {
      "readonly": true, 
      "required": false, 
      "title": "revision number of the desired state", 
      "type": "integer"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FirewallSectionsSummary (type) 

{
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "FirewallSectionsSummary", 
  "module_id": "FirewallSummary", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "rule_count": {
      "description": "Total number of rules in the section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "section_count": {
      "description": "Total number of sections for the section type.", 
      "readonly": true, 
      "required": false, 
      "title": "Section count", 
      "type": "integer"
    }, 
    "section_type": {
      "$ref": "FirewallCategory"+, 
      "description": "Type of rules which a section can contain.", 
      "readonly": true, 
      "required": false, 
      "title": "Section Type"
    }
  }, 
  "type": "object"
}

FirewallService (type) 

{
  "extends": {
    "$ref": "DSService"+
  }, 
  "id": "FirewallService", 
  "module_id": "Firewall", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "service": {
      "$ref": "NSServiceElement"+, 
      "description": "Distributed Service API accepts raw protocol and ports as part of NS service element\nin Distributed Service Rule that describes traffic corresponding to an NSService.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Distributed Service Network and Security Service element"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

FirewallStats (type) 

{
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "FirewallStats", 
  "module_id": "FirewallStatsRule", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "byte_count": {
      "description": "Aggregated number of bytes processed by the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "bytes count", 
      "type": "integer"
    }, 
    "max_popularity_index": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "The maximum popularity index", 
      "type": "integer"
    }, 
    "max_session_count": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Maximum Sessions count", 
      "type": "integer"
    }, 
    "packet_count": {
      "description": "Aggregated number of packets processed by the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "packets count", 
      "type": "integer"
    }, 
    "popularity_index": {
      "description": "This is calculated by sessions count divided by age of the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "The index of the popularity of firewall rule", 
      "type": "integer"
    }, 
    "rule_id": {
      "description": "Rule Identifier of the Firewall rule. This is a globally unique number.", 
      "readonly": true, 
      "required": false, 
      "title": "Firewall rule Id", 
      "type": "string"
    }, 
    "session_count": {
      "description": "Aggregated number of sessions processed by the rule.", 
      "readonly": true, 
      "required": false, 
      "title": "sessions count", 
      "type": "integer"
    }, 
    "total_session_count": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Total Sessions count", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

FirewallStatus (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "FirewallStatus", 
  "module_id": "FirewallStatus", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "context": {
      "$ref": "FirewallContextType"+, 
      "description": "Types of firewall contexts.", 
      "readonly": false, 
      "required": true, 
      "title": "Firewall Context Type"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "global_status": {
      "$ref": "FirewallStatusType"+, 
      "description": "Firewall status for a fabric entity or in global context where firewall is supported.", 
      "readonly": false, 
      "required": true, 
      "title": "Firewall Status Type"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_statuses": {
      "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).", 
      "items": {
        "$ref": "TargetResourceStatus"+
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of target resource status", 
      "type": "array"
    }
  }, 
  "title": "Firewall Status Response", 
  "type": "object"
}

FirewallStatusListResult (type) 

{
  "description": "List of firewall statuses for a context or all context", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "FirewallStatusListResult", 
  "module_id": "FirewallStatus", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "FirewallStatus"+
      }, 
      "readonly": true, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Firewall Statuses", 
  "type": "object"
}

FirewallStatusType (type) 

{
  "description": "Types of firewall statuses representing state of DFW for a context type (e.g. transport_nodes).", 
  "enum": [
    "DISABLED", 
    "ENABLED"
  ], 
  "id": "FirewallStatusType", 
  "module_id": "FirewallStatus", 
  "title": "Firewall Status Type", 
  "type": "string"
}

Footer (type) 

{
  "additionalProperties": false, 
  "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.", 
  "id": "Footer", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "actions": {
      "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.", 
      "items": {
        "$ref": "FooterAction"+
      }, 
      "minItems": 0, 
      "title": "Footer Actions", 
      "type": "array"
    }, 
    "condition": {
      "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.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }
  }, 
  "title": "Widget Footer", 
  "type": "object"
}

FooterAction (type) 

{
  "additionalProperties": false, 
  "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.", 
  "id": "FooterAction", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "dock_to_container_footer": {
      "default": true, 
      "description": "If true, the footer will appear in the underlying container that holds the widget.", 
      "title": "Dock the footer at container", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label"+, 
      "description": "Label to be displayed against the footer action.", 
      "required": true, 
      "title": "Label for action"
    }, 
    "url": {
      "description": "Hyperlink to the UI page that provides details of action.", 
      "maxLength": 1024, 
      "title": "Clickable hyperlink, if any", 
      "type": "string"
    }
  }, 
  "title": "Widget Footer Action", 
  "type": "object"
}

ForwarderZone (type) 

{
  "additionalProperties": false, 
  "id": "ForwarderZone", 
  "module_id": "DnsForwarder", 
  "properties": {
    "source_ip": {
      "$ref": "IPv4Address"+, 
      "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", 
      "required": false, 
      "title": "Source ip of the forwarder"
    }, 
    "upstream_servers": {
      "description": "Ip address of the upstream dns servers the dns forwarder accesses.\n", 
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 3, 
      "minItems": 1, 
      "required": true, 
      "title": "Ips of upsteam dns servers", 
      "type": "array"
    }
  }, 
  "type": "object"
}

GatewayConfig (type) 

{
  "additionalProperties": false, 
  "description": "Stores gateway configuration like nsx_manager_connection,\ndefault_quarantine_policy_enabled and is_ha_enabled.\n", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "GatewayConfig", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "Id of security group where the VMs should be moved after last gateway\nundeployed.\n", 
      "required": false, 
      "title": "Id of cloud security group", 
      "type": "string"
    }, 
    "default_quarantine_policy_enabled": {
      "required": false, 
      "title": "Flag to identify if default quarantine policy is enabled", 
      "type": "boolean"
    }, 
    "dns_settings": {
      "$ref": "DnsSettings"+, 
      "description": "Settings related to Cloud gateway DNS configuration. This determines\nDNS configuration based on dns_mode.\n", 
      "title": "DNS settings"
    }, 
    "is_ha_enabled": {
      "required": false, 
      "title": "Flag to identify if HA is enabled", 
      "type": "boolean"
    }, 
    "nsx_manager_connection": {
      "description": "Determines if connection to NSX Manager is via public IP or private IP\n", 
      "enum": [
        "PUBLIC_IP", 
        "PRIVATE_IP"
      ], 
      "required": false, 
      "title": "NSX Manager connection", 
      "type": "string"
    }, 
    "proxy_server_profile": {
      "description": "Id of the proxy server profile, corresponding proxy settings\nwill be applied while deploying the gateway.\n", 
      "required": false, 
      "title": "Id of the proxy server profile", 
      "type": "string"
    }, 
    "vpn_service_enabled": {
      "default": true, 
      "description": "Flag that will enable or disable inter-operation between NSX and\nnon-NSX services via VPN.\n", 
      "required": false, 
      "title": "Flag to enable or disable inter-operation with services via VPN", 
      "type": "boolean"
    }
  }, 
  "title": "Gateway configuration", 
  "type": "object"
}

GatewayInstanceStatus (type) 

{
  "additionalProperties": false, 
  "description": "Stores information about gateway instance status", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "GatewayInstanceStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "deployment_step": {
      "enum": [
        "VALIDATING_ENVIRONMENT", 
        "COPYING_IMAGE", 
        "CREATING_SECURITY_GROUPS", 
        "LAUNCHING_GATEWAY", 
        "CREATING_NETWORK_INTERFACES", 
        "ATTACHING_NETWORK_INTERFACES", 
        "ATTACHING_SECURITY_GROUPS", 
        "CONFIGURING_GATEWAY", 
        "CREATING_LOGICAL_NETWORK_CONSTRUCTS", 
        "DEPLOYMENT_SUCCESSFUL", 
        "DEPLOYMENT_FAILED", 
        "UNCONFIGURING_GATEWAY", 
        "RELEASING_EIPS", 
        "TERMINATING_GATEWAY", 
        "DELETING_SECURITY_GROUPS", 
        "DELETING_CLOUD_RESOURCES", 
        "UNDEPLOYMENT_SUCCESSFUL", 
        "UNDEPLOYMENT_FAILED", 
        "NOT_APPLICABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Different states of gateway deployment", 
      "type": "string"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for gateway deployment/undeployment failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for gateway deployment/undeployment failure", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": false, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "gateway_instance_id": {
      "required": false, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }, 
    "gateway_lcp_connectivity_status": {
      "description": "Status of connectivity between NSX controller and public cloud gateway.\n", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Controller connectivity status", 
      "type": "string"
    }, 
    "gateway_mpa_connectivity_status": {
      "description": "Status of connectivity between NSX manager and public cloud gateway.\n", 
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Manager connectivity status", 
      "type": "string"
    }, 
    "gateway_name": {
      "required": false, 
      "title": "Name of the gateway instance", 
      "type": "string"
    }, 
    "gateway_node_id": {
      "required": false, 
      "title": "NSX Node ID of the public cloud gateway", 
      "type": "string"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway instance status", 
      "type": "string"
    }, 
    "gateway_tn_id": {
      "required": false, 
      "title": "NSX transport node id of the public cloud gateway", 
      "type": "string"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is an active gateway", 
      "type": "boolean"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "vpn_private_ip": {
      "description": "Private IP address of the virtual machine for VPN", 
      "readonly": true, 
      "required": false, 
      "title": "VPN Private IP address", 
      "type": "string"
    }
  }, 
  "title": "Gateway instance status", 
  "type": "object"
}

GatewayPublicIp (type) 

{
  "additionalProperties": false, 
  "description": "Stores gateway public IP settings like ip_allocation_mode and ip_address.\n", 
  "id": "GatewayPublicIp", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "ip_allocation_mode": {
      "default": "ALLOCATE_NEW", 
      "description": "ALLOCATE_NEW: Allocate new public IP.\nUSE_EXISTING: Use cloud provider public IP.\nDONT_ALLOCATE: Don't allocate any public IP.\n", 
      "enum": [
        "ALLOCATE_NEW", 
        "USE_EXISTING", 
        "DONT_ALLOCATE"
      ], 
      "title": "IP Allocation Mode", 
      "type": "string"
    }, 
    "public_ip": {
      "description": "Stores IP address from the Azure public IP service.\nThe IP address will be used ip_allocation_mode is set to USE_EXISTING.\n", 
      "format": "ipv4", 
      "required": false, 
      "title": "Public IP Address", 
      "type": "string"
    }
  }, 
  "title": "Gateway Public IP Information", 
  "type": "object"
}

GatewayStats (type) 

{
  "additionalProperties": false, 
  "id": "GatewayStats", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "deploying": {
      "description": "The number of gateways with status DEPLOYING.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateways with status DEPLOYING", 
      "type": "integer"
    }, 
    "down": {
      "description": "The number of gateways with status DOWN.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateways with status DOWN", 
      "type": "integer"
    }, 
    "up": {
      "description": "The number of gateways with status UP.", 
      "readonly": true, 
      "required": false, 
      "title": "Gateways with status UP", 
      "type": "integer"
    }
  }, 
  "title": "Gateway statistics", 
  "type": "object"
}

GenericDhcpOption (type) 

{
  "additionalProperties": false, 
  "id": "GenericDhcpOption", 
  "module_id": "Dhcp", 
  "properties": {
    "code": {
      "maximum": 255, 
      "minimum": 0, 
      "required": true, 
      "title": "dhcp option code, [0-255]", 
      "type": "integer"
    }, 
    "values": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 10, 
      "minItems": 1, 
      "required": true, 
      "title": "dhcp option value", 
      "type": "array"
    }
  }, 
  "type": "object"
}

GetCertParameter (type) 

{
  "additionalProperties": false, 
  "id": "GetCertParameter", 
  "module_id": "CertificateManager", 
  "properties": {
    "details": {
      "default": false, 
      "required": false, 
      "title": "whether to expand the pem data and show all its details", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

GlobalCollectionConfiguration (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "GlobalCollectionConfiguration", 
  "module_id": "AggSvcDataCollectionConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "aggregated_data_collection_frequency": {
      "description": "The frequency in seconds at which data, which is subject to the aggregation function, is collected.", 
      "maximum": 86400, 
      "minimum": 60, 
      "required": true, 
      "title": "Aggregated Data Collection Frequency In Seconds", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_data_collection_enabled": {
      "description": "Indicates whether data collection required by the aggregation service is enabled.  If false, no aggregation service data will be collected.  Changing this property will not affect the existing data collection frequency settings.", 
      "required": true, 
      "title": "Is data collection enabled", 
      "type": "boolean"
    }, 
    "modified_feature_stack_collection_configurations": {
      "$ref": "FeatureStackCollectionConfigurationList"+, 
      "description": "The list of the locally modified feature stack data collection frequency settings.  If all feature stack data collection configurations are set to their default values, this list will be empty.", 
      "readonly": true, 
      "title": "Modified feature stack collection configurations"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

GlobalRestoreStatus (type) 

{
  "id": "GlobalRestoreStatus", 
  "module_id": "ClusterRestore", 
  "properties": {
    "description": {
      "readonly": true, 
      "required": true, 
      "title": "A description of the restore status", 
      "type": "string"
    }, 
    "value": {
      "enum": [
        "NOT_AVAILABLE", 
        "NOT_STARTED", 
        "SUCCESS", 
        "ERROR", 
        "RUNNING", 
        "SUSPENDING", 
        "SUSPENDED", 
        "ABORTED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Global rolled-up restore status value", 
      "type": "string"
    }
  }, 
  "title": "Overall restore process status", 
  "type": "object"
}

GridConfiguration (type) 

{
  "additionalProperties": false, 
  "description": "Represents configuration of a Grid or Table widget.", 
  "extends": {
    "$ref": "WidgetConfiguration"+
  }, 
  "id": "GridConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "GridConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "columns": {
      "description": "Array of columns of a Grid widget", 
      "items": {
        "$ref": "ColumnItem"+
      }, 
      "required": true, 
      "title": "Columns", 
      "type": "array"
    }, 
    "datasources": {
      "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.", 
      "items": {
        "$ref": "Datasource"+
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "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.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "footer": {
      "$ref": "Footer"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "page_size": {
      "default": 30, 
      "description": "Number of records per page. page_size will be effective only when the urls provided in the datasource support paging.", 
      "title": "Page Size", 
      "type": "int"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "row_list_fields": {
      "description": "Rows of grid or table are formed from the list of objects returned by a row list field.", 
      "items": {
        "$ref": "RowListField"+
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "List of fields from which rows are formed", 
      "type": "array"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "span": {
      "default": 2, 
      "description": "Represents the horizontal span of the Grid.", 
      "title": "Horizontal width of grid widget", 
      "type": "int"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Grid Configuration", 
  "type": "object"
}

GroupStatusListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "GroupStatusListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "has_errors": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to return only upgrade units with errors", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

HaVipConfig (type) 

{
  "additionalProperties": false, 
  "id": "HaVipConfig", 
  "module_id": "LogicalRouter", 
  "properties": {
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "Flag to enable this ha vip config.", 
      "type": "boolean"
    }, 
    "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.", 
      "items": {
        "$ref": "VIPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Floating IP address subnets", 
      "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).", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Identifiers of uplink ports for providing redundancy", 
      "type": "array"
    }
  }, 
  "type": "object"
}

HostAggregateInfo (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "HostAggregateInfo", 
  "module_id": "NsxQuery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "host": {
      "$ref": "HostNode"+, 
      "description": "Host attributes", 
      "readonly": true
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "NodeStatus"+, 
      "description": "Host status", 
      "readonly": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_node": {
      "$ref": "TransportNode"+, 
      "readonly": true, 
      "required": false
    }
  }, 
  "title": "Aggregation of desired and runtime status of host", 
  "type": "object"
}

HostAggregateInfoListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "HostAggregateInfoListResult", 
  "module_id": "NsxQuery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "HostAggregateInfo"+
      }, 
      "required": true, 
      "title": "Host Aggregate Info Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Host aggregate state list result", 
  "type": "object"
}

HostInfraTrafficType (type) 

{
  "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", 
  "id": "HostInfraTrafficType", 
  "module_id": "NiocProfile", 
  "nsx_feature": "Nioc", 
  "properties": {
    "dynamic_res_pool_name": {
      "required": false, 
      "title": "Dynamic resource pool traffic name", 
      "type": "string"
    }, 
    "traffic_name": {
      "enum": [
        "FAULT_TOLERANCE", 
        "HBR", 
        "ISCSI", 
        "MANAGEMENT", 
        "NFS", 
        "VDP", 
        "VIRTUAL_MACHINE", 
        "VMOTION", 
        "VSAN"
      ], 
      "required": false, 
      "title": "Traffic types", 
      "type": "string"
    }
  }, 
  "title": "Enumerate all types of traffic", 
  "type": "object"
}

HostNode (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Node"+
  }, 
  "id": "HostNode", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "HostNode"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_ip_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Discovered IP Addresses of the fabric node, version 4 or 6", 
      "type": "array"
    }, 
    "discovered_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the discovered node which was converted to create this node", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "ID of the Node maintained on the Node and used to recognize the Node", 
      "type": "string"
    }, 
    "fqdn": {
      "readonly": true, 
      "required": false, 
      "title": "Fully qualified domain name of the fabric node", 
      "type": "string"
    }, 
    "host_credential": {
      "$ref": "HostNodeLoginCredential"+, 
      "required": false, 
      "title": "Login credentials for the host"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "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", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": false, 
      "title": "IP Addresses of the Node, version 4 or 6", 
      "type": "array"
    }, 
    "managed_by_server": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the virtual center server managing the ESXi type HostNode.", 
      "type": "string"
    }, 
    "os_type": {
      "enum": [
        "ESXI", 
        "RHELKVM", 
        "UBUNTUKVM", 
        "HYPERV", 
        "RHELCONTAINER", 
        "RHELSERVER", 
        "UBUNTUSERVER", 
        "CENTOSSERVER", 
        "CENTOSKVM"
      ], 
      "required": true, 
      "title": "Hypervisor type, for example ESXi or RHEL KVM.", 
      "type": "string"
    }, 
    "os_version": {
      "required": false, 
      "title": "The version of the hypervisor operating system.", 
      "type": "string"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'", 
      "required": true, 
      "title": "Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

HostNodeLoginCredential (type) 

{
  "additionalProperties": false, 
  "id": "HostNodeLoginCredential", 
  "module_id": "FabricNode", 
  "properties": {
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "The authentication password of the host node", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "For ESXi hosts, the thumbprint of the ESXi management service.\nFor KVM hosts, the SSH key fingerprint.\n", 
      "required": false, 
      "title": "ESXi thumbprint or SSH key fingerprint of the host node", 
      "type": "string"
    }, 
    "username": {
      "required": false, 
      "title": "The username of the account on the host node", 
      "type": "string"
    }
  }, 
  "title": "The credentials to login into the host node", 
  "type": "object"
}

HostProfileNetworkMigrationSpec (type) 

{
  "additionalProperties": false, 
  "description": "This specification should be used to define which VMK adapters need to be\nmigrated to NSX logical switches from VC network switches. Migrations specified\nhere should match with those from associated Host Profiles from VC.\nMismatch will result in migration failures.\nThis specification only supports migration vmkernal adapters to NSX logical switches.\n", 
  "extends": {
    "$ref": "NetworkMigrationSpec"+
  }, 
  "id": "HostProfileNetworkMigrationSpec", 
  "module_id": "TransportNode", 
  "nsx_feature": "HostProfileSupport", 
  "polymorphic-type-descriptor": {
    "type-identifier": "HostProfileNetworkMigrationSpec"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "network_mappings": {
      "description": "Based on provided mappings, VMkernal adapters will be migrated to mentioned\nlogical switch. Without mappings specification doesn't make any sense, hence\nminium one mapping should be specified. Assuming some sane value of 10 maximum\nmigrations which will be supported by any single specification.\n", 
      "items": {
        "$ref": "VmkToLogicalSwitchMapping"+
      }, 
      "maxItems": 10, 
      "minItems": 1, 
      "title": "List of VMkernal adapters to logical switch mappings.", 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "NetworkMigrationSpecType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Specification for network migrations related with Host Profiles.", 
  "type": "object"
}

HostSwitch (type) 

{
  "id": "HostSwitch", 
  "module_id": "TransportNode", 
  "properties": {
    "host_switch_name": {
      "default": "nsxDefaultHostSwitch", 
      "description": "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.", 
      "required": false, 
      "title": "HostSwitch name. This name will be used to reference this HostSwitch.", 
      "type": "string"
    }, 
    "host_switch_profile_ids": {
      "description": "HostSwitch profiles bound to this HostSwitch. 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 HostSwitch.", 
      "items": {
        "$ref": "HostSwitchProfileTypeIdEntry"+
      }, 
      "required": false, 
      "title": "Id's of HostSwitch profiles to be associated with this HostSwitch.", 
      "type": "array"
    }, 
    "pnics": {
      "items": {
        "$ref": "Pnic"+
      }, 
      "required": false, 
      "title": "Physical NICs connected to the host switch", 
      "type": "array"
    }, 
    "static_ip_pool_id": {
      "deprecated": true, 
      "description": "ID of configured Static IP Pool. If specified allocate IP for Endpoints from Pool. Else assume IP will be assigned for Endpoints from DHCP. This field is deprecated, use ip_assignment_spec field instead.", 
      "required": false, 
      "title": "ID of already configured Static IP Pool.", 
      "type": "string"
    }
  }, 
  "title": "Host Switch specification", 
  "type": "object"
}

HostSwitchProfileListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "HostSwitchProfileListParameters", 
  "module_id": "BaseHostSwitchProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "hostswitch_profile_type": {
      "$ref": "HostSwitchProfileType"+, 
      "required": false, 
      "title": "Type of host switch profile"
    }, 
    "include_system_owned": {
      "default": false, 
      "required": false, 
      "title": "Whether the list result contains system resources", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "uplink_teaming_policy_name": {
      "description": "If populated, only UplinkHostSwitchProfiles with the specified uplink teaming policy name are returned. Otherwise, any HostSwitchProfile can be returned.", 
      "required": false, 
      "title": "The host switch profile's uplink teaming policy name", 
      "type": "string"
    }
  }, 
  "title": "HostSwitchProfile List Parameters", 
  "type": "object"
}

HostSwitchProfileType (type) 

{
  "enum": [
    "UplinkHostSwitchProfile", 
    "LldpHostSwitchProfile", 
    "NiocProfile", 
    "ExtraConfigHostSwitchProfile"
  ], 
  "id": "HostSwitchProfileType", 
  "module_id": "BaseHostSwitchProfile", 
  "title": "Supported HostSwitch profiles.", 
  "type": "string"
}

HostSwitchProfileTypeIdEntry (type) 

{
  "id": "HostSwitchProfileTypeIdEntry", 
  "module_id": "BaseHostSwitchProfile", 
  "properties": {
    "key": {
      "$ref": "HostSwitchProfileType"+
    }, 
    "value": {
      "description": "key value", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

HostSwitchProfilesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "HostSwitchProfilesListResult", 
  "module_id": "BaseHostSwitchProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BaseHostSwitchProfile"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "HostSwitch Profile Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "HostSwitch Profile queries result", 
  "type": "object"
}

HostSwitchSpec (type) 

{
  "abstract": true, 
  "description": "The HostSwitchSpec is the base class for standard and preconfigured\nhost switch specifications.\n", 
  "id": "HostSwitchSpec", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "StandardHostSwitchSpec", 
        "PreconfiguredHostSwitchSpec"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Abstract base type for transport node host switch specification", 
  "type": "object"
}

HostSwitchState (type) 

{
  "id": "HostSwitchState", 
  "module_id": "TransportNode", 
  "properties": {
    "endpoints": {
      "items": {
        "$ref": "Endpoint"+
      }, 
      "readonly": true, 
      "title": "List of virtual tunnel endpoints which are configured on this switch", 
      "type": "array"
    }, 
    "host_switch_id": {
      "readonly": true, 
      "title": "External ID of the HostSwitch", 
      "type": "string"
    }, 
    "host_switch_name": {
      "description": "The name must be unique among all host switches specified in a given Transport Node.", 
      "readonly": true, 
      "title": "HostSwitch name. This name will be used to reference this HostSwitch.", 
      "type": "string"
    }, 
    "transport_zone_ids": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "List of Ids of TransportZones this HostSwitch belongs to", 
      "type": "array"
    }
  }, 
  "title": "Host Switch State", 
  "type": "object"
}

HostUpgradeStatus (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus"+
  }, 
  "id": "HostUpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "can_skip": {
      "readonly": true, 
      "required": false, 
      "title": "Can the upgrade of the remaining units in this component be skipped", 
      "type": "boolean"
    }, 
    "component_type": {
      "readonly": true, 
      "required": false, 
      "title": "Component type for the upgrade status", 
      "type": "string"
    }, 
    "details": {
      "readonly": true, 
      "required": false, 
      "title": "Details about the upgrade status", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of component", 
      "type": "string"
    }
  }, 
  "title": "Status of host upgrade", 
  "type": "object"
}

HostnameOrIPv4Address (type) 

{
  "format": "hostname-or-ipv4", 
  "id": "HostnameOrIPv4Address", 
  "module_id": "Common", 
  "title": "Hostname or IPv4 address", 
  "type": "string"
}

HostnameOrIPv4AddressOrEmptyString (type) 

{
  "id": "HostnameOrIPv4AddressOrEmptyString", 
  "maxLength": 255, 
  "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])?)*\\.?$|^$", 
  "title": "Hostname or IPv4 address", 
  "type": "string"
}

HttpProtocol (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol"+
  }, 
  "id": "HttpProtocol", 
  "polymorphic-type-descriptor": {
    "type-identifier": "http"
  }, 
  "properties": {
    "authentication_scheme": {
      "$ref": "BasicAuthenticationScheme"+, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

HttpRequestMethodType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "GET", 
    "OPTIONS", 
    "POST", 
    "HEAD", 
    "PUT"
  ], 
  "id": "HttpRequestMethodType", 
  "module_id": "LoadBalancer", 
  "title": "http monitor method", 
  "type": "string"
}

HttpRequestVersionType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "HTTP_VERSION_1_0", 
    "HTTP_VERSION_1_1", 
    "HTTP_VERSION_2_0"
  ], 
  "id": "HttpRequestVersionType", 
  "module_id": "LoadBalancer", 
  "title": "http request version", 
  "type": "string"
}

HttpServiceProperties (type) 

{
  "additionalProperties": false, 
  "id": "HttpServiceProperties", 
  "properties": {
    "certificate": {
      "$ref": "Certificate"+, 
      "readonly": true, 
      "required": true
    }, 
    "cipher_suites": {
      "items": {
        "$ref": "CipherSuite"+
      }, 
      "minItems": 1, 
      "title": "Cipher suites used to secure contents of connection", 
      "type": "array"
    }, 
    "client_api_concurrency_limit": {
      "default": 40, 
      "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.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls", 
      "type": "integer"
    }, 
    "client_api_rate_limit": {
      "default": 100, 
      "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.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls per second", 
      "type": "integer"
    }, 
    "connection_timeout": {
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX connection timeout, set to 0 to configure no timeout", 
      "type": "integer"
    }, 
    "global_api_concurrency_limit": {
      "default": 100, 
      "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.", 
      "minimum": 0, 
      "title": "Global API rate limit in calls", 
      "type": "integer"
    }, 
    "protocol_versions": {
      "items": {
        "$ref": "ProtocolVersion"+
      }, 
      "minItems": 1, 
      "title": "TLS protocol versions", 
      "type": "array"
    }, 
    "redirect_host": {
      "$ref": "HostnameOrIPv4AddressOrEmptyString"+, 
      "default": "", 
      "title": "Host name or IP address to use for redirect location headers, or empty string to derive from current request"
    }, 
    "session_timeout": {
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX session inactivity timeout, set to 0 to configure no timeout", 
      "type": "integer"
    }
  }, 
  "title": "HTTP Service properties", 
  "type": "object"
}

HttpsProtocol (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol"+
  }, 
  "id": "HttpsProtocol", 
  "polymorphic-type-descriptor": {
    "type-identifier": "https"
  }, 
  "properties": {
    "authentication_scheme": {
      "$ref": "BasicAuthenticationScheme"+, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "sha256_thumbprint": {
      "required": true, 
      "title": "SSL thumbprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ICMPTypeNSService (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "ICMPTypeNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ICMPTypeNSService"
  }, 
  "properties": {
    "icmp_code": {
      "required": false, 
      "title": "ICMP message code", 
      "type": "integer"
    }, 
    "icmp_type": {
      "required": false, 
      "title": "ICMP message type", 
      "type": "integer"
    }, 
    "protocol": {
      "enum": [
        "ICMPv4", 
        "ICMPv6"
      ], 
      "required": true, 
      "title": "ICMP protocol type", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }
  }, 
  "title": "A NSService that represents IPv4 or IPv6 ICMP protocol", 
  "type": "object"
}

IGMPTypeNSService (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "IGMPTypeNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IGMPTypeNSService"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }
  }, 
  "title": "A NSService that represents IGMP protocol", 
  "type": "object"
}

IKEDigestAlgorithm (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "IKEDigestAlgorithm", 
  "module_id": "IPSecVPN", 
  "title": "Digest Algorithms used in IKE negotiations", 
  "type": "string"
}

IKEEncryptionAlgorithm (type) 

{
  "additionalProperties": false, 
  "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.\nAES_GCM stands for Advanced Encryption Standard(AES) in\nGalois/Counter Mode(GCM) and is used to provide both\nconfidentiality and data origin authentication. AES_GCM composed\nof two separate functions one for encryption(AES) and one for\nauthentication(GMAC). AES_GCM algorithms will be available with\nIKE_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"
  ], 
  "id": "IKEEncryptionAlgorithm", 
  "module_id": "IPSecVPN", 
  "title": "Encryption algorithms used in IKE", 
  "type": "string"
}

IPAddress (type) 

{
  "format": "ip", 
  "id": "IPAddress", 
  "module_id": "Common", 
  "title": "IPv4 or IPv6 address", 
  "type": "string"
}

IPElement (type) 

{
  "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", 
  "id": "IPElement", 
  "module_id": "Common", 
  "title": "IP address, range, or subnet", 
  "type": "string"
}

IPInfo (type) 

{
  "id": "IPInfo", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IPv4 Addresses", 
      "type": "array"
    }, 
    "prefix_length": {
      "maximum": 32, 
      "minimum": 1, 
      "required": true, 
      "title": "Subnet Prefix Length", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

IPMirrorDestination (type) 

{
  "extends": {
    "$ref": "MirrorDestination"+
  }, 
  "id": "IPMirrorDestination", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IPMirrorDestination"
  }, 
  "properties": {
    "destination_ips": {
      "description": "The destination IPs of the mirror packet will be sent to.", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "maxItems": 3, 
      "minItems": 1, 
      "required": true, 
      "title": "List of destination IP addresses", 
      "type": "array"
    }, 
    "encapsulation_type": {
      "$ref": "EncapsulationType"+, 
      "default": "GRE", 
      "description": "You can choose GRE, ERSPAN II or ERSPAN III.", 
      "required": true, 
      "title": "IPMirrorDestination encapsulation type"
    }, 
    "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", 
      "maximum": 1023, 
      "minimum": 0, 
      "required": false, 
      "title": "ERSPAN session id", 
      "type": "int"
    }, 
    "gre_key": {
      "description": "User-configurable 32-bit key only for GRE", 
      "required": false, 
      "title": "GRE encapsulation key", 
      "type": "int"
    }, 
    "resource_type": {
      "$ref": "MirrorDestinationResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorDestination'", 
      "required": true
    }
  }, 
  "type": "object"
}

IPPrefixList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPPrefixList", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "prefixes": {
      "items": {
        "$ref": "PrefixConfig"+
      }, 
      "maxItems": 1330000, 
      "minItems": 1, 
      "required": true, 
      "title": "Ordered list of PrefixConfig", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

IPPrefixListListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPPrefixListListResult", 
  "module_id": "Routing", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPPrefixList"+
      }, 
      "required": true, 
      "title": "Paginated list of IPPrefixLists", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

IPProtocolNSService (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "IPProtocolNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IPProtocolNSService"
  }, 
  "properties": {
    "protocol_number": {
      "required": true, 
      "title": "The IP protocol number", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }
  }, 
  "title": "An NSService element that represents an IP protocol", 
  "type": "object"
}

IPSecVPNDPDProfile (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSecVPNDPDProfile", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "dpd_probe_interval": {
      "default": 60, 
      "description": "DPD probe interval defines a periodic interval for DPD probes.", 
      "maximum": 360, 
      "minimum": 3, 
      "title": "DPD probe interval in seconds", 
      "type": "integer"
    }, 
    "enabled": {
      "default": true, 
      "description": "If true, enable dead peer detection.", 
      "title": "Enable dead peer detection (DPD)", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Dead peer detection (DPD) profile", 
  "type": "object"
}

IPSecVPNDPDProfileListResult (type) 

{
  "additionalProperties": false, 
  "description": "List all the dead peer detection (DPD) profiles.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSecVPNDPDProfileListResult", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSecVPNDPDProfile"+
      }, 
      "required": true, 
      "title": "IPSec DPD Profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List dead peer detection (DPD) profiles", 
  "type": "object"
}

IPSecVPNIKEProfile (type) 

{
  "additionalProperties": false, 
  "description": "IKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSecVPNIKEProfile", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dh_groups": {
      "description": "Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.", 
      "items": {
        "$ref": "DHGroup"+
      }, 
      "title": "DH group", 
      "type": "array"
    }, 
    "digest_algorithms": {
      "description": "Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.", 
      "items": {
        "$ref": "IKEDigestAlgorithm"+
      }, 
      "title": "Algorithm for message hash", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "encryption_algorithms": {
      "description": "Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.", 
      "items": {
        "$ref": "IKEEncryptionAlgorithm"+
      }, 
      "title": "Encryption algorithm for IKE", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_version": {
      "default": "IKE-V2", 
      "description": "IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.", 
      "enum": [
        "IKE_V1", 
        "IKE_V2", 
        "IKE_FLEX"
      ], 
      "title": "IKE version", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sa_life_time": {
      "default": 86400, 
      "description": "Life time for security association. Default is 86400 seconds (1 day).", 
      "maximum": 31536000, 
      "minimum": 21600, 
      "title": "Security association (SA) life time", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Internet key exchange (IKE) profile", 
  "type": "object"
}

IPSecVPNIKEProfileListResult (type) 

{
  "additionalProperties": false, 
  "description": "List all the IKE profiles.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSecVPNIKEProfileListResult", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSecVPNIKEProfile"+
      }, 
      "required": true, 
      "title": "IKE Profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List IKE profiles", 
  "type": "object"
}

IPSecVPNLocalEndpoint (type) 

{
  "additionalProperties": false, 
  "description": "Local endpoint represents a logical router on which tunnel needs to be terminated.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSecVPNLocalEndpoint", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "certificate_id": {
      "description": "Site certificate identifier. Field is marked for future use. Certificate based authentication is not supported.", 
      "title": "Certificate Id", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipsec_vpn_service_id": {
      "$ref": "ResourceReference"+, 
      "description": "VPN Service id.", 
      "required": true, 
      "title": "VPN Service id"
    }, 
    "local_address": {
      "$ref": "IPv4Address"+, 
      "description": "IPV4 Address for local endpoint.", 
      "required": true, 
      "title": "IPV4 Address for local endpoint"
    }, 
    "local_id": {
      "description": "Local identifier.", 
      "title": "Local identifier", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "trust_ca_ids": {
      "description": "Certificate authority (CA) identifier list to verify peer certificates. Field is marked for future use. Certificate based authentication is not supported.", 
      "items": {
        "type": "string"
      }, 
      "title": "Certificate authority (CA) identifiers", 
      "type": "array"
    }, 
    "trust_crl_ids": {
      "description": "Certificate revocation list (CRL) identifier list to peer certificates. Field is marked for future use. Certificate based authentication is not supported.", 
      "items": {
        "type": "string"
      }, 
      "title": "Certificate revocation list (CRL) Identifiers", 
      "type": "array"
    }
  }, 
  "title": "IPSec VPN Local Endpoint", 
  "type": "object"
}

IPSecVPNLocalEndpointListParameters (type) 

{
  "additionalProperties": false, 
  "description": "Parameters to get the filtered list of IPSec VPN local endpoints. Both filter parameters can be provided as they are not mutually exclusive.", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "IPSecVPNLocalEndpointListParameters", 
  "module_id": "IPSecVPN", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ipsec_vpn_service_id": {
      "description": "All the local endpoints configured with the specified VPN Service id will be included in the result.", 
      "required": false, 
      "title": "Id of the IPSec VPN service", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "All the local endpoints belonging to the specified logical router id will be included in the result.", 
      "required": false, 
      "title": "Id of logical router", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List parameters for IPSec VPN local endpoints", 
  "type": "object"
}

IPSecVPNLocalEndpointListResult (type) 

{
  "additionalProperties": false, 
  "description": "List all the local endpoints.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSecVPNLocalEndpointListResult", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSecVPNLocalEndpoint"+
      }, 
      "required": true, 
      "title": "IPSec local endpoint list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List local endpoints", 
  "type": "object"
}

IPSecVPNPeerEndpoint (type) 

{
  "additionalProperties": false, 
  "description": "IPSec VPN Peer Endpoint covers configuration to be applied locally to establish a session with remote endpoint on peer site.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSecVPNPeerEndpoint", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "authentication_mode": {
      "default": "PSK", 
      "description": "For peer authentication only Pre shared key (PSK) mode will be supported.", 
      "enum": [
        "PSK"
      ], 
      "title": "Authentication Mode", 
      "type": "string"
    }, 
    "connection_initiation_mode": {
      "default": "INITIATOR", 
      "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", 
      "enum": [
        "INITIATOR", 
        "RESPOND_ONLY", 
        "ON_DEMAND"
      ], 
      "title": "Connection initiation mode", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "dpd_profile_id": {
      "description": "Dead peer detection (DPD) profile id. Default will be set according to system default policy.", 
      "title": "Dead peer detection (DPD) profile id", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_profile_id": {
      "description": "IKE profile id to be used. Default will be set according to system default policy.", 
      "title": "Internet key exchange (IKE) profile id", 
      "type": "string"
    }, 
    "ipsec_tunnel_profile_id": {
      "description": "Tunnel profile id to be used. By default it will point to system default profile.", 
      "title": "IPSec tunnel profile id", 
      "type": "string"
    }, 
    "peer_address": {
      "description": "IPV4 address of peer endpoint on remote site.", 
      "required": true, 
      "title": "IPV4 address of peer endpoint on remote site.", 
      "type": "string"
    }, 
    "peer_id": {
      "description": "Peer identifier.", 
      "required": true, 
      "title": "Peer id", 
      "type": "string"
    }, 
    "psk": {
      "description": "IPSec Pre-shared key. Maximum length of this field is 128 characters.", 
      "sensitive": true, 
      "title": "Pre-shared key", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IPSec VPN Peer Endpoint", 
  "type": "object"
}

IPSecVPNPeerEndpointListResult (type) 

{
  "additionalProperties": false, 
  "description": "List all the peer endpoints.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSecVPNPeerEndpointListResult", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSecVPNPeerEndpoint"+
      }, 
      "required": true, 
      "title": "IPSec Peer endpoint list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List peer endpoints", 
  "type": "object"
}

IPSecVPNPolicyRule (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "EmbeddedResource"+
  }, 
  "id": "IPSecVPNPolicyRule", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink"+, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "action": {
      "default": "PROTECT", 
      "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", 
      "enum": [
        "PROTECT", 
        "BYPASS"
      ], 
      "readonly": true, 
      "title": "Action to be applied", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of peer subnets.", 
      "items": {
        "$ref": "IPSecVPNPolicySubnet"+
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Destination list", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "A flag to enable/disable the policy rule.", 
      "title": "Enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "description": "Unique policy id.", 
      "title": "Unique policy id", 
      "type": "string"
    }, 
    "logged": {
      "default": false, 
      "description": "A flag to enable/disable the logging for the policy rule.", 
      "title": "Logging flag", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sources": {
      "description": "List of local subnets.", 
      "items": {
        "$ref": "IPSecVPNPolicySubnet"+
      }, 
      "maxItems": 128, 
      "required": false, 
      "title": "Source list", 
      "type": "array"
    }
  }, 
  "title": "IPSec VPN policy rules", 
  "type": "object"
}

IPSecVPNPolicySubnet (type) 

{
  "additionalProperties": false, 
  "description": "Used to specify the local/peer subnets in IPSec VPN Policy rule.", 
  "id": "IPSecVPNPolicySubnet", 
  "module_id": "IPSecVPN", 
  "properties": {
    "subnet": {
      "$ref": "IPv4CIDRBlock"+, 
      "description": "Subnet used in policy rule.", 
      "required": true, 
      "title": "Peer or local subnet"
    }
  }, 
  "title": "Subnet for IPSec Policy based VPN", 
  "type": "object"
}

IPSecVPNService (type) 

{
  "additionalProperties": false, 
  "description": "Create and manage IPSec VPN service for given logical router.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSecVPNService", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bypass_rules": {
      "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", 
      "items": {
        "$ref": "IPSecVPNPolicyRule"+
      }, 
      "required": false, 
      "title": "Bypass Policy rules", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "If true, enable VPN services for given logical router.", 
      "title": "Enable virtual private network (VPN) service", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ike_log_level": {
      "default": "INFO", 
      "description": "Log level for internet key exchange (IKE).", 
      "enum": [
        "DEBUG", 
        "INFO", 
        "WARN", 
        "ERROR", 
        "EMERGENCY"
      ], 
      "title": "Internet key exchange (IKE) log level", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "Logical router id.", 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IPSec VPN service", 
  "type": "object"
}

IPSecVPNServiceListResult (type) 

{
  "additionalProperties": false, 
  "description": "List all the IPSec VPN services.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSecVPNServiceListResult", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSecVPNService"+
      }, 
      "required": true, 
      "title": "IPSec VPN serivce list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List IPSec VPN services", 
  "type": "object"
}

IPSecVPNSession (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "VPN session defines connection between local and peer endpoint. Untill VPN session is defined configuration is not realized.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSecVPNSession", 
  "module_id": "IPSecVPN", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable/Disable IPSec VPN session.", 
      "title": "Enable/Disable IPSec VPN session", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipsec_vpn_service_id": {
      "description": "Identifier of VPN Service linked with local endpoint.", 
      "readonly": true, 
      "title": "IPSec VPN service identifier", 
      "type": "string"
    }, 
    "local_endpoint_id": {
      "description": "Local endpoint identifier.", 
      "required": true, 
      "title": "Local endpoint identifier", 
      "type": "string"
    }, 
    "peer_endpoint_id": {
      "description": "Peer endpoint identifier.", 
      "required": true, 
      "title": "Peer endpoint identifier", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IPSecVPNSessionResourceType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IPSec VPN session", 
  "type": "object"
}

IPSecVPNSessionListParameters (type) 

{
  "additionalProperties": false, 
  "description": "Parameters to get filtered list of IPSec VPN Sessions. The filter parameters are not mutually exclusive and can be used together.", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "IPSecVPNSessionListParameters", 
  "module_id": "IPSecVPN", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ipsec_vpn_service_id": {
      "description": "All the IPSec VPN sessions configured with the specified VPN Service id will be included in the result.", 
      "required": false, 
      "title": "Id of the IPSec VPN service", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "All the VPN sessions belonging to the specified logical router id will be included in the result.", 
      "required": false, 
      "title": "Id of logical router", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "session_type": {
      "$ref": "IPSecVPNSessionResourceType"+, 
      "description": "All the IPSec VPN sessions of specified type will be included in the result.", 
      "required": false, 
      "title": "Type of the vpn session"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List parameters for IPSec VPN Sessions", 
  "type": "object"
}

IPSecVPNSessionListResult (type) 

{
  "additionalProperties": false, 
  "description": "List all the IPSec VPN sessions.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSecVPNSessionListResult", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSecVPNSession"+
      }, 
      "required": true, 
      "title": "IPSec VPN sessions list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List IPSec VPN sessions", 
  "type": "object"
}

IPSecVPNSessionResourceType (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "IPSecVPNSessionResourceType", 
  "module_id": "IPSecVPN", 
  "title": "Resource types of IPsec VPN session", 
  "type": "string"
}

IPSecVPNTunnelProfile (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSecVPNTunnelProfile", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "df_policy": {
      "default": "COPY", 
      "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.", 
      "enum": [
        "COPY", 
        "CLEAR"
      ], 
      "title": "Policy for handling defragmentation bit", 
      "type": "string"
    }, 
    "dh_groups": {
      "description": "Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.", 
      "items": {
        "$ref": "DHGroup"+
      }, 
      "title": "DH group", 
      "type": "array"
    }, 
    "digest_algorithms": {
      "description": "Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm \"AES_GCM_128\".", 
      "items": {
        "$ref": "TunnelDigestAlgorithm"+
      }, 
      "title": "Algorithm for message hash", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable_perfect_forward_secrecy": {
      "default": true, 
      "description": "If true, perfect forward secrecy (PFS) is enabled.", 
      "title": "Enable perfect forward secrecy", 
      "type": "boolean"
    }, 
    "encapsulation_mode": {
      "default": "TUNNEL_MODE", 
      "description": "Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet.", 
      "enum": [
        "TUNNEL_MODE"
      ], 
      "readonly": true, 
      "title": "Encapsulation Mode", 
      "type": "string"
    }, 
    "encryption_algorithms": {
      "description": "Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.", 
      "items": {
        "$ref": "TunnelEncryptionAlgorithm"+
      }, 
      "title": "Encryption algorithm to use in tunnel establishement", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sa_life_time": {
      "default": 3600, 
      "description": "SA life time specifies the expiry time of security\nassociation. Default is 3600 seconds.\n", 
      "maximum": 31536000, 
      "minimum": 900, 
      "title": "Security association (SA) life time", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transform_protocol": {
      "default": "ESP", 
      "description": "IPSec transform specifies IPSec security protocol.", 
      "enum": [
        "ESP"
      ], 
      "readonly": true, 
      "title": "Tunnel protocol", 
      "type": "string"
    }
  }, 
  "title": "IPSec VPN tunnel profile", 
  "type": "object"
}

IPSecVPNTunnelProfileListResult (type) 

{
  "additionalProperties": false, 
  "description": "List all the tunnel profiles.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSecVPNTunnelProfileListResult", 
  "module_id": "IPSecVPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSecVPNTunnelProfile"+
      }, 
      "required": true, 
      "title": "IPSec Tunnel Profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List tunnel profiles", 
  "type": "object"
}

IPSet (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IPSet", 
  "module_id": "IPSet", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "items": {
        "$ref": "IPElement"+
      }, 
      "maxItems": 4000, 
      "required": false, 
      "title": "IP addresses", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Set of one or more IP addresses", 
  "type": "object"
}

IPSetListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "IPSetListRequestParameters", 
  "module_id": "IPSet", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPSet list request parameters", 
  "type": "object"
}

IPSetListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IPSetListResult", 
  "module_id": "IPSet", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IPSet"+
      }, 
      "required": true, 
      "title": "IPSet list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged collection of IPSets", 
  "type": "object"
}

IPSubnet (type) 

{
  "additionalProperties": false, 
  "id": "IPSubnet", 
  "module_id": "LogicalRouterPorts", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IPv4 Addresses", 
      "type": "array"
    }, 
    "prefix_length": {
      "maximum": 32, 
      "minimum": 1, 
      "required": true, 
      "title": "Subnet Prefix Length", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

IPv4Address (type) 

{
  "format": "ipv4", 
  "id": "IPv4Address", 
  "module_id": "Common", 
  "title": "IPv4 address", 
  "type": "string"
}

IPv4AddressProperties (type) 

{
  "additionalProperties": false, 
  "id": "IPv4AddressProperties", 
  "properties": {
    "ip_address": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface IPv4 address", 
      "type": "string"
    }, 
    "netmask": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface netmask", 
      "type": "string"
    }
  }, 
  "title": "IPv4 address properties", 
  "type": "object"
}

IPv4CIDRBlock (type) 

{
  "format": "ipv4-cidr-block", 
  "id": "IPv4CIDRBlock", 
  "module_id": "Common", 
  "title": "IPv4 CIDR Block", 
  "type": "string"
}

IPv4DhcpServer (type) 

{
  "additionalProperties": false, 
  "id": "IPv4DhcpServer", 
  "module_id": "Dhcp", 
  "properties": {
    "dhcp_server_ip": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": true, 
      "title": "dhcp server ip in cidr format"
    }, 
    "dns_nameservers": {
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "dns ips", 
      "type": "array"
    }, 
    "domain_name": {
      "format": "hostname", 
      "required": false, 
      "title": "domain name", 
      "type": "string"
    }, 
    "gateway_ip": {
      "$ref": "IPv4Address"+, 
      "required": false, 
      "title": "gateway ip"
    }, 
    "options": {
      "$ref": "DhcpOptions"+, 
      "description": "Defines the default options for all ip-pools and static-bindings of this server.\nThese options will be ignored if options are defined for ip-pools or static-bindings.\n", 
      "required": false, 
      "title": "dhcp options"
    }
  }, 
  "type": "object"
}

Icon (type) 

{
  "additionalProperties": false, 
  "description": "Icon to be applied at dashboard for widgets and UI elements.", 
  "id": "Icon", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "placement": {
      "default": "PRE", 
      "description": "If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.", 
      "enum": [
        "PRE", 
        "POST"
      ], 
      "title": "Position at which to display icon, if any", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the icon.", 
      "items": {
        "$ref": "Tooltip"+
      }, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "type": {
      "description": "Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered.", 
      "enum": [
        "ERROR", 
        "WARNING", 
        "INFO", 
        "INPROGRESS", 
        "SUCCESS", 
        "DETAIL", 
        "NOT_AVAILABLE"
      ], 
      "title": "Type of icon", 
      "type": "string"
    }
  }, 
  "title": "Icon", 
  "type": "object"
}

IncludedFieldsParameters (type) 

{
  "additionalProperties": false, 
  "id": "IncludedFieldsParameters", 
  "module_id": "Common", 
  "properties": {
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }
  }, 
  "title": "A list of fields to include in query results", 
  "type": "object"
}

IngressBroadcastRateShaper (type) 

{
  "extends": {
    "$ref": "QosBaseRateShaper"+
  }, 
  "id": "IngressBroadcastRateShaper", 
  "module_id": "QosSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IngressBroadcastRateShaper"
  }, 
  "properties": {
    "average_bandwidth_kbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Average bandwidth in kb/s", 
      "type": "int"
    }, 
    "burst_size_bytes": {
      "default": 0, 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth_kbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Peak bandwidth in kb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateShaper", 
      "enum": [
        "IngressRateShaper", 
        "IngressBroadcastRateShaper", 
        "EgressRateShaper"
      ], 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies ingress rate properties in kb/s", 
  "type": "object"
}

IngressRateShaper (type) 

{
  "extends": {
    "$ref": "QosBaseRateShaper"+
  }, 
  "id": "IngressRateShaper", 
  "module_id": "QosSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IngressRateShaper"
  }, 
  "properties": {
    "average_bandwidth_mbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Average bandwidth in Mb/s", 
      "type": "int"
    }, 
    "burst_size_bytes": {
      "default": 0, 
      "minimum": 0, 
      "title": "Burst size in bytes", 
      "type": "int"
    }, 
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "peak_bandwidth_mbps": {
      "default": 0, 
      "minimum": 0, 
      "title": "Peak bandwidth in Mb/s", 
      "type": "int"
    }, 
    "resource_type": {
      "default": "IngressRateShaper", 
      "enum": [
        "IngressRateShaper", 
        "IngressBroadcastRateShaper", 
        "EgressRateShaper"
      ], 
      "type": "string"
    }
  }, 
  "title": "A shaper that specifies ingress rate properties in Mb/s", 
  "type": "object"
}

InitiateClusterRestoreRequest (type) 

{
  "id": "InitiateClusterRestoreRequest", 
  "module_id": "ClusterRestore", 
  "properties": {
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique id of the backed-up configuration from which\nthe appliance will be restored\n", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": true, 
      "title": "Timestamp of the backed-up configuration from which\nthe appliance will be restored\n"
    }
  }, 
  "type": "object"
}

InstallUpgradeServiceProperties (type) 

{
  "additionalProperties": false, 
  "id": "InstallUpgradeServiceProperties", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "True if service enabled; otherwise, false", 
      "type": "boolean"
    }, 
    "enabled_on": {
      "readonly": true, 
      "title": "IP of manager on which install-upgrade is enabled", 
      "type": "string"
    }
  }, 
  "title": "install-upgrade service properties", 
  "type": "object"
}

InstalledAppsParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "InstalledAppsParameters", 
  "module_id": "AppDiscovery", 
  "properties": {
    "app_profile_id": {
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vm_id": {
      "type": "string"
    }
  }, 
  "type": "object"
}

InstanceDeploymentConfig (type) 

{
  "description": "The Instance Deployment Config contains settings that is applied during install time.", 
  "id": "InstanceDeploymentConfig", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "compute_id": {
      "description": "Resource Pool or Compute Id.", 
      "readonly": false, 
      "required": true, 
      "title": "compute id", 
      "type": "string"
    }, 
    "context_id": {
      "description": "Context Id or VCenter Id.", 
      "readonly": false, 
      "required": true, 
      "title": "Context Id", 
      "type": "string"
    }, 
    "storage_id": {
      "description": "Storage Id.", 
      "readonly": false, 
      "required": true, 
      "title": "storage id", 
      "type": "string"
    }, 
    "vm_nic_infos": {
      "description": "List of set of NIC information for VMs", 
      "items": {
        "$ref": "VmNicInfo"+
      }, 
      "maxItems": 2, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "List of VM NIC information", 
      "type": "array"
    }
  }, 
  "title": "Instance Deployment Config", 
  "type": "object"
}

InstanceEndpoint (type) 

{
  "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.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "InstanceEndpoint", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "endpoint_type": {
      "default": "LOGICAL", 
      "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.", 
      "enum": [
        "LOGICAL", 
        "VIRTUAL"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Instance Endpoint Type", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "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.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "readonly": false, 
      "required": false, 
      "title": "Link Id list", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "service_attachments": {
      "description": "Id(s) of the Service Attachment where this enndpoint is connected to. Service Attachment is mandatory for LOGICAL Instance Endpoint.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "readonly": false, 
      "required": false, 
      "title": "Service Attachment list", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "target_ips": {
      "description": "Target IPs on an interface of the Service Instance.", 
      "items": {
        "$ref": "IPInfo"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Target IPs", 
      "type": "array"
    }
  }, 
  "title": "EndPoint of an Instance", 
  "type": "object"
}

InstanceEndpointListResult (type) 

{
  "description": "List of instance endpoints.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "InstanceEndpointListResult", 
  "module_id": "ServiceInsertion", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of instance endpoints.", 
      "items": {
        "$ref": "InstanceEndpoint"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Instance End Point list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Instance Endpoint List", 
  "type": "object"
}

InstanceRuntime (type) 

{
  "description": "A Service Runtime is the runtime entity associated with ever Service-VM deployed.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "InstanceRuntime", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "deployment_status": {
      "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.", 
      "enum": [
        "DEPLOYMENT_IN_PROGRESS", 
        "DEPLOYMENT_FAILED", 
        "DEPLOYMENT_SUCCESSFUL", 
        "UPGRADE_IN_PROGRESS", 
        "UPGRADE_FAILED", 
        "UNDEPLOYMENT_IN_PROGRESS", 
        "UNDEPLOYMENT_FAILED", 
        "UNDEPLOYMENT_SUCCESSFUL", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Instance Runtime deployment status", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "error_message": {
      "description": "Error message for the Service Instance Runtime if any.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Message", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "runtime_status": {
      "description": "Service-Instance Runtime status of the deployed Service-VM.", 
      "enum": [
        "IN_SERVICE", 
        "OUT_OF_SERVICE", 
        "NEEDS_ATTENTION", 
        "NOT_AVAILABLE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Instance Runtime Status", 
      "type": "string"
    }, 
    "service_instance_id": {
      "description": "Id of an instantiation of a registered service.", 
      "readonly": true, 
      "required": false, 
      "title": "Service instance id", 
      "type": "string"
    }, 
    "service_vm_id": {
      "description": "Service-VM/SVM id of deployed virtual-machine.", 
      "readonly": true, 
      "required": false, 
      "title": "Service VM id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vm_nic_info": {
      "$ref": "VmNicInfo"+, 
      "readonly": true, 
      "required": false, 
      "title": "VM NIC info"
    }
  }, 
  "title": "Runtime of a Service-Instance.", 
  "type": "object"
}

InstanceRuntimeListResult (type) 

{
  "additionalProperties": false, 
  "description": "Result of List of InstanceRuntimes", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "InstanceRuntimeListResult", 
  "module_id": "ServiceInsertionVMDeployment", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of existing InstanceRuntimes in database\n", 
      "items": {
        "$ref": "InstanceRuntime"+
      }, 
      "required": true, 
      "title": "Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "InstanceRuntime list result", 
  "type": "object"
}

InstanceStats (type) 

{
  "additionalProperties": false, 
  "description": "Stores statistics of the instances like MANAGED and UNMANAGED instances.\n", 
  "id": "InstanceStats", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "error": {
      "description": "The number of instances with status ERROR.", 
      "readonly": true, 
      "required": false, 
      "title": "Error Instances", 
      "type": "integer"
    }, 
    "managed": {
      "description": "The number of instances with status MANAGED.", 
      "readonly": true, 
      "required": false, 
      "title": "Managed Instances", 
      "type": "integer"
    }, 
    "powered_off": {
      "description": "The number of instances with status POWERED OFF.", 
      "readonly": true, 
      "required": false, 
      "title": "Powered Off Instances", 
      "type": "integer"
    }, 
    "total": {
      "description": "The total number of instances.", 
      "readonly": true, 
      "required": false, 
      "title": "Total number of instances", 
      "type": "integer"
    }, 
    "unmanaged": {
      "description": "The number of instances with status UNMANAGED.", 
      "readonly": true, 
      "required": false, 
      "title": "Unmanaged Instances", 
      "type": "integer"
    }, 
    "vcpus": {
      "description": "The number of virtual CPUs.", 
      "readonly": true, 
      "required": false, 
      "title": "Virtual CPUs", 
      "type": "integer"
    }
  }, 
  "title": "Instance statistics", 
  "type": "object"
}

InstructionInfo (type) 

{
  "id": "InstructionInfo", 
  "module_id": "ClusterRestore", 
  "properties": {
    "actions": {
      "description": "A list of actions that are to be applied to resources", 
      "help_detail": "This attribute lists actions that are to be applied to the resources\nreferenced in the \"resources\" attribute. There is an m x n relationship\nbetween these actions and resources.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Actions list", 
      "type": "array"
    }, 
    "fields": {
      "description": "A list of fields that are displayable to users in a table", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Displayable fields", 
      "type": "array"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "UUID of the instruction", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "Instruction name", 
      "type": "string"
    }
  }, 
  "title": "Details of the instructions displayed during restore process", 
  "type": "object"
}

InterfaceNeighborProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "InterfaceNeighborProperties", 
  "module_id": "Lldp", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ifindex": {
      "display": {
        "order": 3
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Interface index", 
      "type": "integer"
    }, 
    "mac": {
      "display": {
        "order": 2
      }, 
      "pattern": "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$", 
      "readonly": true, 
      "required": true, 
      "title": "Interface MAC address", 
      "type": "string"
    }, 
    "name": {
      "display": {
        "order": 1
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Interface Name", 
      "type": "string"
    }, 
    "neighbors": {
      "display": {
        "order": 4
      }, 
      "items": {
        "$ref": "NeighborProperties"+
      }, 
      "readonly": true, 
      "title": "Neighbor properties", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Interface neighbor properties", 
  "type": "object"
}

InterfaceNeighborPropertyListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "InterfaceNeighborPropertyListResult", 
  "module_id": "Lldp", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "InterfaceNeighborProperties"+
      }, 
      "title": "Interface neighbor property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Interface neighbor property query results", 
  "type": "object"
}

InterfaceStatistics (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "InterfaceStatistics", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "rx_bytes": {
      "display": {
        "order": 1
      }, 
      "readonly": true, 
      "title": "Count of bytes received on this port", 
      "type": "integer"
    }, 
    "rx_errors": {
      "display": {
        "order": 5
      }, 
      "readonly": true, 
      "title": "Count of receive errors occurring on this port", 
      "type": "integer"
    }, 
    "rx_packets": {
      "display": {
        "order": 2
      }, 
      "readonly": true, 
      "title": "Count of packets received on this port", 
      "type": "integer"
    }, 
    "tx_bytes": {
      "display": {
        "order": 3
      }, 
      "readonly": true, 
      "title": "Count of bytes transmitted on this port", 
      "type": "integer"
    }, 
    "tx_errors": {
      "display": {
        "order": 6
      }, 
      "readonly": true, 
      "title": "Count of transmit errors occurring on this port", 
      "type": "integer"
    }, 
    "tx_packets": {
      "display": {
        "order": 4
      }, 
      "readonly": true, 
      "title": "Count of packets transmitted on this port", 
      "type": "integer"
    }
  }, 
  "title": "Statistics for a network interface", 
  "type": "object"
}

IntervalBackupSchedule (type) 

{
  "extends": {
    "$ref": "BackupSchedule"+
  }, 
  "id": "IntervalBackupSchedule", 
  "module_id": "BackupConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IntervalBackupSchedule"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "WeeklyBackupSchedule", 
        "IntervalBackupSchedule"
      ], 
      "required": true, 
      "title": "Schedule type", 
      "type": "string"
    }, 
    "seconds_between_backups": {
      "default": 3600, 
      "maximum": 86400, 
      "minimum": 300, 
      "title": "Time interval in seconds between two consecutive automated backups", 
      "type": "integer"
    }
  }, 
  "title": "Schedule to specify the interval time at which automated backups need to be taken", 
  "type": "object"
}

IpAddressInfo (type) 

{
  "additionalProperties": false, 
  "id": "IpAddressInfo", 
  "module_id": "Inventory", 
  "properties": {
    "ip_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "IP Addresses of the the virtual network interface, as discovered in the source.", 
      "type": "array"
    }, 
    "source": {
      "enum": [
        "VM_TOOLS"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Source of the ipaddress information.", 
      "type": "string"
    }
  }, 
  "title": "Ipaddress information of the fabric node.", 
  "type": "object"
}

IpAllocationBase (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpAllocationBase", 
  "module_id": "Dhcp", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "gateway_ip": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "gateway ip"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lease_time": {
      "default": 86400, 
      "maximum": 4294967295, 
      "minimum": 60, 
      "required": false, 
      "title": "lease time, in seconds, [60-(2^32-1)], default 86400", 
      "type": "integer"
    }, 
    "options": {
      "$ref": "DhcpOptions"+, 
      "description": "If an option is defined at server level and not configred at\nip-pool/static-binding level, the option will be inherited to\nip-pool/static-binding. If both define a same-code option, the\noption defined at ip-pool/static-binding level take precedence\nover that defined at server level.\n", 
      "required": false, 
      "title": "dhcp options"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

IpAssignmentSpec (type) 

{
  "abstract": true, 
  "id": "IpAssignmentSpec", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "StaticIpPoolSpec", 
        "StaticIpListSpec", 
        "AssignedByDhcp", 
        "StaticIpMacListSpec"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Abstract base type for specification of IPs to be used with host switch virtual tunnel endpoints", 
  "type": "object"
}

IpBlock (type) 

{
  "additionalProperties": false, 
  "description": "A block of IPv4 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 /                         (___________________________________________/________) /                                                                     / =======================================================================", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpBlock", 
  "module_id": "Ipam", 
  "nsx_feature": "Container", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "cidr": {
      "format": "ipv4-cidr-block", 
      "required": true, 
      "title": "Represents network address and the prefix length which will be associated with a layer-2 broadcast domain", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

IpBlockListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpBlockListResult", 
  "module_id": "Ipam", 
  "nsx_feature": "Container", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpBlock"+
      }, 
      "required": true, 
      "title": "IP block list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

IpBlockSubnet (type) 

{
  "additionalProperties": false, 
  "description": "A set of IPv4 addresses defined by a start address and a mask/prefix which will typically be associated with a layer-2 broadcast domain.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpBlockSubnet", 
  "module_id": "Ipam", 
  "nsx_feature": "Container", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allocation_ranges": {
      "items": {
        "$ref": "IpPoolRange"+
      }, 
      "readonly": true, 
      "title": "A collection of IPv4 IP ranges used for IP allocation.", 
      "type": "array"
    }, 
    "block_id": {
      "readonly": false, 
      "required": true, 
      "title": "Block id for which the subnet is created.", 
      "type": "string"
    }, 
    "cidr": {
      "format": "ipv4-cidr-block", 
      "readonly": true, 
      "title": "Represents network address and the prefix length which will be associated with a layer-2 broadcast domain", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "size": {
      "required": true, 
      "title": "Represents the size or number of ip addresses in the subnet", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

IpBlockSubnetListRequestParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "IpBlockSubnetListRequestParameters", 
  "module_id": "Ipam", 
  "nsx_feature": "Container", 
  "properties": {
    "block_id": {
      "required": false, 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

IpBlockSubnetListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpBlockSubnetListResult", 
  "module_id": "Ipam", 
  "nsx_feature": "Container", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpBlockSubnet"+
      }, 
      "required": true, 
      "title": "IP block subnet list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

IpDiscoverySwitchingProfile (type) 

{
  "extends": {
    "$ref": "BaseSwitchingProfile"+
  }, 
  "id": "IpDiscoverySwitchingProfile", 
  "module_id": "IpDiscoverySwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IpDiscoverySwitchingProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "arp_bindings_limit": {
      "default": 1, 
      "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.", 
      "maximum": 128, 
      "minimum": 1, 
      "title": "Number of arp snooped IP addresses", 
      "type": "int"
    }, 
    "arp_snooping_enabled": {
      "default": true, 
      "display": {
        "order": 1
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Indicates whether ARP snooping is enabled", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_snooping_enabled": {
      "default": true, 
      "display": {
        "order": 2
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Indicates whether DHCP snooping is enabled", 
      "type": "boolean"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vm_tools_enabled": {
      "default": false, 
      "description": "This option is only supported on ESX where vm-tools is installed.", 
      "display": {
        "order": 3
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Indicates whether fetching IP using vm-tools is enabled", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

IpMacPair (type) 

{
  "id": "IpMacPair", 
  "module_id": "TransportNode", 
  "properties": {
    "ip": {
      "$ref": "IPAddress"+, 
      "readonly": false, 
      "required": true, 
      "title": "IP address"
    }, 
    "mac": {
      "$ref": "MACAddress"+, 
      "readonly": false, 
      "required": false, 
      "title": "MAC address"
    }
  }, 
  "title": "IP and MAC pair.", 
  "type": "object"
}

IpPool (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpPool", 
  "module_id": "Ipam", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "pool_usage": {
      "$ref": "PoolUsage"+, 
      "readonly": true, 
      "title": "Pool usage statistics"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "subnets": {
      "description": "Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.", 
      "items": {
        "$ref": "IpPoolSubnet"+
      }, 
      "maxItems": 5, 
      "title": "The collection of one or more subnet objects in a pool", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

IpPoolListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpPoolListResult", 
  "module_id": "Ipam", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpPool"+
      }, 
      "required": true, 
      "title": "IP pool list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

IpPoolRange (type) 

{
  "additionalProperties": false, 
  "description": "A set of IPv4 or IPv6 addresses defined by a start and end address.", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "IpPoolRange", 
  "module_id": "Ipam", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "end": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "The end IP Address of the IP Range."
    }, 
    "start": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "The start IP Address of the IP Range."
    }
  }, 
  "type": "object"
}

IpPoolSubnet (type) 

{
  "additionalProperties": false, 
  "description": "A set of IPv4 or IPv6 addresses defined by a network CIDR.", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "IpPoolSubnet", 
  "module_id": "Ipam", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "allocation_ranges": {
      "items": {
        "$ref": "IpPoolRange"+
      }, 
      "required": true, 
      "title": "A collection of IPv4 or IPv6 IP Pool Ranges.", 
      "type": "array"
    }, 
    "cidr": {
      "required": true, 
      "title": "Represents network address and the prefix length which will be associated with a layer-2 broadcast domain", 
      "type": "string"
    }, 
    "dns_nameservers": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "maxItems": 3, 
      "title": "The collection of upto 3 DNS servers for the subnet.", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "dns_suffix": {
      "format": "hostname", 
      "title": "The DNS suffix for the DNS server.", 
      "type": "string"
    }, 
    "gateway_ip": {
      "$ref": "IPAddress"+, 
      "title": "The default gateway address on a layer-3 router."
    }
  }, 
  "type": "object"
}

IpfixCollector (type) 

{
  "id": "IpfixCollector", 
  "module_id": "Ipfix", 
  "properties": {
    "collector_ip_address": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "IP address for the IPFIX collector"
    }, 
    "collector_port": {
      "default": 4739, 
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Port for the IPFIX collector", 
      "type": "int"
    }
  }, 
  "type": "object"
}

IpfixCollectorConfig (type) 

{
  "description": "This managed entity contains a set of IPFIX collectors.\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpfixCollectorConfig", 
  "module_id": "Ipfix", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "collectors": {
      "items": {
        "$ref": "IpfixCollector"+
      }, 
      "maxItems": 4, 
      "minItems": 1, 
      "required": true, 
      "title": "IPFIX Collectors", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

IpfixCollectorConfigListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpfixCollectorConfigListResult", 
  "module_id": "Ipfix", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpfixCollectorConfig"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "IPFIX Collector Config", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of IPFIX Collector Configs", 
  "type": "object"
}

IpfixCollectorUpmProfile (type) 

{
  "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", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpfixCollectorUpmProfile", 
  "module_id": "UpmIpfixCollector", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "collectors": {
      "items": {
        "$ref": "IpfixCollector"+
      }, 
      "maxItems": 4, 
      "minItems": 1, 
      "required": true, 
      "title": "IPFIX Collector Set", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IpfixCollectorUpmProfileType"+, 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IPFIX Collector Profile", 
  "type": "object"
}

IpfixCollectorUpmProfileListParameters (type) 

{
  "description": "Query parameters for IPFIX collector profile list", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "IpfixCollectorUpmProfileListParameters", 
  "module_id": "UpmIpfixCollector", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "profile_types": {
      "description": "An English comma-separated list of profile types. Enumerated value in\nIpfixCollectorUpmProfileType can be listed here as a filter param.\n", 
      "required": false, 
      "title": "IPFIX Collector Profile Type List", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX Collector Profile List Parameters", 
  "type": "object"
}

IpfixCollectorUpmProfileListResult (type) 

{
  "description": "IPFIX collector profile list result for query with profile list parameters\n", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpfixCollectorUpmProfileListResult", 
  "module_id": "UpmIpfixCollector", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpfixCollectorUpmProfile"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "IPFIX Collector Profile List", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of IPFIX Collector Profiles", 
  "type": "object"
}

IpfixCollectorUpmProfileType (type) 

{
  "description": "All IPFIX collector profile types.", 
  "enum": [
    "IpfixCollectorUpmProfile"
  ], 
  "id": "IpfixCollectorUpmProfileType", 
  "module_id": "UpmIpfixCollector", 
  "title": "IPFIX Collector Profile Types", 
  "type": "string"
}

IpfixConfig (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpfixConfig", 
  "module_id": "Ipfix", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "applied_tos": {
      "description": "List of objects where the IPFIX Config will be enabled.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IpfixConfigType"+, 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IPFIX Config base representation", 
  "type": "object"
}

IpfixConfigListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "IpfixConfigListParameters", 
  "module_id": "Ipfix", 
  "properties": {
    "applied_to": {
      "description": "An applied to UUID working as listing condition", 
      "required": false, 
      "title": "Applied To", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ipfix_config_type": {
      "$ref": "IpfixConfigType"+, 
      "required": false, 
      "title": "Type of IPFIX Config"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX Config List Parameters", 
  "type": "object"
}

IpfixConfigListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpfixConfigListResult", 
  "module_id": "Ipfix", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpfixConfig"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "IPFIX Config", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of IPFIX Config", 
  "type": "object"
}

IpfixConfigType (type) 

{
  "enum": [
    "IpfixSwitchConfig", 
    "IpfixDfwConfig"
  ], 
  "id": "IpfixConfigType", 
  "module_id": "Ipfix", 
  "title": "Supported IPFIX Config Types.", 
  "type": "string"
}

IpfixDfwConfig (type) 

{
  "description": "It defines IPFIX DFW Configuration.", 
  "extends": {
    "$ref": "IpfixConfig"+
  }, 
  "id": "IpfixDfwConfig", 
  "module_id": "Ipfix", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IpfixDfwConfig"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_flow_export_timeout": {
      "default": 1, 
      "description": "For long standing active flows, IPFIX records will be sent per timeout period\n", 
      "maximum": 60, 
      "minimum": 1, 
      "required": false, 
      "title": "Active flow export timeout (minutes)", 
      "type": "integer"
    }, 
    "applied_tos": {
      "description": "List of objects where the IPFIX Config will be enabled.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "collector": {
      "description": "Each IPFIX DFW config can have its own collector config.\n", 
      "required": true, 
      "title": "UUID of IPFIX DFW Collector Config", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "observation_domain_id": {
      "description": "An identifier that is unique to the exporting process and used to\nmeter the Flows.\n", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": true, 
      "title": "Observation domain ID", 
      "type": "integer"
    }, 
    "priority": {
      "default": 0, 
      "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", 
      "maximum": 65536, 
      "minimum": 0, 
      "required": true, 
      "title": "Config Priority", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "IpfixConfigType"+, 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "template_parameters": {
      "$ref": "IpfixDfwTemplateParameters"+, 
      "description": "An object that indicates whether each corresponding template parameter\nis required or not.\n", 
      "required": false, 
      "title": "Template Parameters"
    }
  }, 
  "title": "IPFIX Config for the DFW Module", 
  "type": "object"
}

IpfixDfwTemplateParameters (type) 

{
  "description": "This entity represents the flow parameters which are exported.\n", 
  "id": "IpfixDfwTemplateParameters", 
  "module_id": "Ipfix", 
  "properties": {
    "destination_address": {
      "default": true, 
      "description": "The destination IP address of a monitored network flow.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "destination_transport_port": {
      "default": true, 
      "description": "The destination transport port of a monitored network flow.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "firewall_event": {
      "default": true, 
      "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", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "flow_direction": {
      "default": true, 
      "description": "Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01:\negress flow from VM.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "flow_end": {
      "default": true, 
      "description": "The absolute timestamp (seconds) of the last packet of this flow.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "flow_start": {
      "default": true, 
      "description": "The absolute timestamp (seconds) of the first packet of this flow.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "icmp_code": {
      "default": true, 
      "description": "Code of the IPv4 ICMP message.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "octet_delta_count": {
      "default": true, 
      "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", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "packet_delta_count": {
      "default": true, 
      "description": "The number of incoming packets since the previous report (if any)\nfor this flow at the observation point.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "protocol_identifier": {
      "default": true, 
      "description": "The value of the protocol number in the IP packet header.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "rule_id": {
      "default": true, 
      "description": "Firewall rule Id - enterprise specific Information Element that uniquely identifies\nfirewall rule.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "source_address": {
      "default": true, 
      "description": "The source IP address of a monitored network flow.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "source_icmp_type": {
      "default": true, 
      "description": "Type of the IPv4 ICMP message.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "source_transport_port": {
      "default": true, 
      "description": "The source transport port of a monitored network flow.\n", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "vif_uuid": {
      "default": true, 
      "description": "VIF UUID - enterprise specific Information Element that uniquely identifies VIF.\n", 
      "readonly": true, 
      "type": "boolean"
    }
  }, 
  "title": "IPFIX DFW Template Parameters", 
  "type": "object"
}

IpfixObsPointConfig (type) (Deprecated) 

{
  "deprecated": true, 
  "description": "IpfixObsPointConfig (i.e. global switch IPFIX config) is deprecated. Please\nuse IpfixSwitchUpmProfile & IpfixCollectorUpmProfile instead. With them,\nswitch IPFIX profile can be applied to specific entities, such as logical\nswitch, logical port and so on.\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpfixObsPointConfig", 
  "module_id": "Ipfix", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_timeout": {
      "default": 300, 
      "description": "The time in seconds after a Flow is expired even if more packets\nmatching this Flow are received by the cache.\n", 
      "maximum": 3600, 
      "minimum": 60, 
      "required": false, 
      "title": "Active timeout", 
      "type": "int"
    }, 
    "collectors": {
      "items": {
        "$ref": "IpfixCollector"+
      }, 
      "required": false, 
      "title": "List of IPFIX collectors", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "required": true, 
      "title": "Enabled status of IPFIX export", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 300, 
      "description": "The time in seconds after a Flow is expired if no more packets matching\nthis Flow are received by the cache.\n", 
      "maximum": 3600, 
      "minimum": 60, 
      "required": false, 
      "title": "Idle timeout", 
      "type": "int"
    }, 
    "max_flows": {
      "default": 16384, 
      "description": "The maximum number of flow entries in each exporter flow cache.\n", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Max flows", 
      "type": "integer"
    }, 
    "observation_domain_id": {
      "default": 0, 
      "description": "An identifier that is unique to the exporting process and used to\nmeter the Flows.\n", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Observation domain ID", 
      "type": "integer"
    }, 
    "packet_sample_probability": {
      "default": 0.1, 
      "description": "The probability in percentage that a packet is sampled, in range\n0-100. The probability is equal for every packet.\n", 
      "exclusiveMinimum": true, 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Packet sample probability", 
      "type": "number"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Logical IPFIX observation point", 
  "type": "object"
}

IpfixObsPointsListResult (type) (Deprecated) 

{
  "deprecated": true, 
  "description": "This is deprecated. Please use UpmProfileListResult instead.\n", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpfixObsPointsListResult", 
  "module_id": "Ipfix", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpfixObsPointConfig"+
      }, 
      "title": "IPFIX observation points", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of logical IPFIX observation points", 
  "type": "object"
}

IpfixServiceAssociationListResult (type) 

{
  "extends": {
    "$ref": "ServiceAssociationListResult"+
  }, 
  "id": "IpfixServiceAssociationListResult", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Ipfix config list result with pagination support.", 
      "items": {
        "$ref": "IpfixConfig"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "IpfixConfig list result", 
      "type": "array"
    }, 
    "service_type": {
      "enum": [
        "FireWallServiceAssociationListResult", 
        "IpfixServiceAssociationListResult"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

IpfixSwitchConfig (type) (Deprecated) 

{
  "deprecated": true, 
  "description": "This is deprecated. Please use IpfixSwitchUpmProfile instead which can\nspecify its own collectors and observation ID.\n", 
  "extends": {
    "$ref": "IpfixConfig"+
  }, 
  "id": "IpfixSwitchConfig", 
  "module_id": "Ipfix", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IpfixSwitchConfig"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_timeout": {
      "default": 300, 
      "description": "The time in seconds after a Flow is expired even if more packets\nmatching this Flow are received by the cache.\n", 
      "maximum": 3600, 
      "minimum": 60, 
      "required": false, 
      "title": "Active timeout", 
      "type": "int"
    }, 
    "applied_tos": {
      "description": "List of objects where the IPFIX Config will be enabled.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 300, 
      "description": "The time in seconds after a Flow is expired if no more packets matching\nthis Flow are received by the cache.\n", 
      "maximum": 3600, 
      "minimum": 60, 
      "required": false, 
      "title": "Idle timeout", 
      "type": "int"
    }, 
    "max_flows": {
      "default": 16384, 
      "description": "The maximum number of flow entries in each exporter flow cache.\n", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Max flows", 
      "type": "integer"
    }, 
    "packet_sample_probability": {
      "default": 0.1, 
      "description": "The probability in percentage that a packet is sampled, in range\n0-100. The probability is equal for every packet.\n", 
      "exclusiveMinimum": true, 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Packet sample probability", 
      "type": "number"
    }, 
    "resource_type": {
      "$ref": "IpfixConfigType"+, 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IPFIX Config for the Switching Module", 
  "type": "object"
}

IpfixSwitchUpmProfile (type) 

{
  "description": "The configuration for Internet protocol flow information export (IPFIX) and\nwould be enabled on the switching module to collect flow information.\n", 
  "extends": {
    "$ref": "IpfixUpmProfile"+
  }, 
  "id": "IpfixSwitchUpmProfile", 
  "module_id": "UpmIpfix", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IpfixSwitchUpmProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_timeout": {
      "default": 300, 
      "description": "The time in seconds after a flow is expired even if more packets\nmatching this Flow are received by the cache.\n", 
      "maximum": 3600, 
      "minimum": 60, 
      "required": false, 
      "title": "Active Timeout", 
      "type": "int"
    }, 
    "applied_tos": {
      "$ref": "AppliedTos"+, 
      "description": "Entities where the IPFIX profile will be enabled on. Maximum\nentity count of all types is 128.\n", 
      "required": false, 
      "title": "Entitys Applied with Profile"
    }, 
    "collector_profile": {
      "description": "Each IPFIX switching profile can have its own collector profile.\n", 
      "required": true, 
      "title": "UUID of IPFIX Collector Profile", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 300, 
      "description": "The time in seconds after a flow is expired if no more packets matching\nthis flow are received by the cache.\n", 
      "maximum": 3600, 
      "minimum": 60, 
      "required": false, 
      "title": "Idle Timeout", 
      "type": "int"
    }, 
    "max_flows": {
      "default": 16384, 
      "description": "The maximum number of flow entries in each exporter flow cache.\n", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Max Flows", 
      "type": "integer"
    }, 
    "observation_domain_id": {
      "description": "An identifier that is unique to the exporting process and used to\nmeter the Flows.\n", 
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": true, 
      "title": "Observation Domain ID", 
      "type": "integer"
    }, 
    "packet_sample_probability": {
      "default": 0.1, 
      "description": "The probability in percentage that a packet is sampled, in range\n(0,100]. The probability is equal for every packet.\n", 
      "exclusiveMinimum": true, 
      "maximum": 100, 
      "minimum": 0, 
      "required": false, 
      "title": "Packet Sample Probability", 
      "type": "number"
    }, 
    "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", 
      "maximum": 65536, 
      "minimum": 0, 
      "required": true, 
      "title": "Profile Priority", 
      "type": "int"
    }, 
    "resource_type": {
      "$ref": "IpfixUpmProfileType"+, 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Switching IPFIX Profile", 
  "type": "object"
}

IpfixUpmProfile (type) 

{
  "abstract": true, 
  "description": "Parent profile of all IPFIX profiles.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "IpfixUpmProfile", 
  "module_id": "UpmIpfix", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IpfixUpmProfileType"+, 
      "readonly": false, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base IPFIX Profile", 
  "type": "object"
}

IpfixUpmProfileListParameters (type) 

{
  "description": "Query parameters for IPFIX profile list", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "IpfixUpmProfileListParameters", 
  "module_id": "UpmIpfix", 
  "properties": {
    "applied_to_entity_id": {
      "description": "The entity ID works as a filter param. Entity ID and entity type should\nbe both provided or not at a query.\n", 
      "readonly": false, 
      "required": false, 
      "title": "ID of Entity Applied with Profile", 
      "type": "string"
    }, 
    "applied_to_entity_type": {
      "$ref": "UpmEntityType"+, 
      "description": "The entity type works as a filter param. Enumerated value in\nUpmEntityType could be used here. Entity ID and entity type should be\nboth provided or not at a query.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Type of Entity Applied with Profile"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "profile_types": {
      "description": "An English comma-separated list of profile types. Enumerated value in\nIpfixUpmProfileType could be listed here as a filter param.\n", 
      "required": false, 
      "title": "IPFIX Profile Type List", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "IPFIX Profile List Parameters", 
  "type": "object"
}

IpfixUpmProfileListResult (type) 

{
  "description": "IPFIX profile list result for query with list parameters", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "IpfixUpmProfileListResult", 
  "module_id": "UpmIpfix", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "IpfixUpmProfile"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "IPFIX Profile List", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of IPFIX Profiles", 
  "type": "object"
}

IpfixUpmProfileType (type) 

{
  "description": "All IPFIX profile types.", 
  "enum": [
    "IpfixSwitchUpmProfile"
  ], 
  "id": "IpfixUpmProfileType", 
  "module_id": "UpmIpfix", 
  "title": "IPFIX Profile Types", 
  "type": "string"
}

KeySize (type) 

{
  "id": "KeySize", 
  "module_id": "CertificateManager", 
  "title": "Crypto key size", 
  "type": "integer"
}

KeyValue (type) 

{
  "additionalProperties": false, 
  "id": "KeyValue", 
  "module_id": "CertificateManager", 
  "properties": {
    "key": {
      "description": "key name", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "value": {
      "description": "key value", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

KeyValuePair (type) 

{
  "additionalProperties": false, 
  "id": "KeyValuePair", 
  "module_id": "Common", 
  "properties": {
    "key": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "value": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "An arbitrary key-value pair", 
  "type": "object"
}

KnownHostParameter (type) 

{
  "additionalProperties": false, 
  "id": "KnownHostParameter", 
  "properties": {
    "host": {
      "$ref": "HostnameOrIPv4Address"+, 
      "required": true, 
      "title": "Known host hostname or IP address"
    }, 
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Known host port", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

L2VpnAttachmentContext (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AttachmentContext"+
  }, 
  "id": "L2VpnAttachmentContext", 
  "module_id": "LogicalPort", 
  "polymorphic-type-descriptor": {
    "type-identifier": "L2VpnAttachmentContext"
  }, 
  "properties": {
    "allocate_addresses": {
      "enum": [
        "IpPool", 
        "MacPool", 
        "Both", 
        "None"
      ], 
      "required": false, 
      "title": "A flag to indicate whether to allocate addresses from allocation\n    pools bound to the parent logical switch.\n", 
      "type": "string"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'VifAttachmentContext' or 'L2VpnAttachmentContext'\n", 
      "required": true, 
      "title": "Used to identify which concrete class it is", 
      "type": "string"
    }, 
    "tunnel_id": {
      "max": 4093, 
      "min": 1, 
      "required": true, 
      "title": "Tunnel Id to uniquely identify the extension.", 
      "type": "int"
    }
  }, 
  "type": "object"
}

L2VpnService (type) 

{
  "additionalProperties": false, 
  "description": "Defines if service running as hub or spoke Also defines all the common properties for the multiple L2VpnSessions associated with this service.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "L2VpnService", 
  "module_id": "L2VPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable_full_mesh": {
      "default": false, 
      "description": "Hub replicates traffic received from peer to all other peers.", 
      "required": false, 
      "title": "Enable to act as hub", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "Logical router id", 
      "required": true, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "logical_tap_ip_pool": {
      "description": "IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical Tap.", 
      "items": {
        "$ref": "IPv4CIDRBlock"+
      }, 
      "required": false, 
      "title": "IP Pool for Logical Taps", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "L2VPN Service", 
  "type": "object"
}

L2VpnServiceListResult (type) 

{
  "additionalProperties": false, 
  "description": "Paginated list all the L2VPN services.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "L2VpnServiceListResult", 
  "module_id": "L2VPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "L2VpnService"+
      }, 
      "required": true, 
      "title": "L2VPN serivce list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List all L2VPN services", 
  "type": "object"
}

L2VpnSession (type) 

{
  "additionalProperties": false, 
  "description": "Defines the tunnel local and peer addresses along with the multiple tansport tunnels for redundancy. L2VpnSession belongs on to only one L2VpnService.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "L2VpnSession", 
  "module_id": "L2VPN", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable to extend all the associated logical switches.", 
      "required": false, 
      "title": "Enable L2VPN session", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "l2vpn_service_id": {
      "description": "L2VPN service id", 
      "required": true, 
      "title": "L2VPN service id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_tunnels": {
      "description": "List of transport tunnels for redundancy.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "List of transport tunnels", 
      "type": "array"
    }, 
    "tunnel_encapsulation": {
      "$ref": "L2VpnTunnelEncapsulation"+, 
      "description": "Tunnel encapsulation config.", 
      "readonly": true, 
      "required": false, 
      "title": "Tunnel encapsulation config"
    }
  }, 
  "title": "L2VPN Session", 
  "type": "object"
}

L2VpnSessionListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "L2VpnSessionListParameters", 
  "module_id": "L2VPN", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "l2vpn_service_id": {
      "description": "If provided, only sessions associated with the given L2Vpn service will be returned", 
      "required": false, 
      "title": "Id of the L2Vpn Service", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "L2VPNSession list parameters", 
  "type": "object"
}

L2VpnSessionListResult (type) 

{
  "additionalProperties": false, 
  "description": "Paginated list all the L2VPN sessions", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "L2VpnSessionListResult", 
  "module_id": "L2VPN", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "L2VpnSession"+
      }, 
      "required": true, 
      "title": "L2VPN sessions list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List all L2VPN sessions", 
  "type": "object"
}

L2VpnTunnelEncapsulation (type) 

{
  "additionalProperties": false, 
  "description": "L2VPN tunnel encapsulation config", 
  "id": "L2VpnTunnelEncapsulation", 
  "module_id": "L2VPN", 
  "properties": {
    "local_endpoint_ip": {
      "$ref": "IPv4Address"+, 
      "description": "IP Address of the tunnel port. The IP are allocated from L2VpnService logical_tap_ip_pool. All sessions on same L2VpnService get the same local_endpoint_ip.", 
      "required": false, 
      "title": "IP Address of the tunnel port"
    }, 
    "peer_endpoint_ip": {
      "$ref": "IPv4Address"+, 
      "description": "IP Address of the peer tunnel port. The IP are allocated from L2VpnService logical_tap_ip_pool.", 
      "required": false, 
      "title": "IP Address of the peer tunnel port"
    }, 
    "protocol": {
      "default": "GRE", 
      "description": "Encapsulation protocol used by the tunnel", 
      "enum": [
        "GRE"
      ], 
      "required": false, 
      "title": "Encapsulation protocol", 
      "type": "string"
    }
  }, 
  "title": "L2VPN tunnel encapsulation config", 
  "type": "object"
}

L4PortSetNSService (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "L4PortSetNSService", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "L4PortSetNSService"
  }, 
  "properties": {
    "destination_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "title": "Destination ports", 
      "type": "array"
    }, 
    "l4_protocol": {
      "enum": [
        "TCP", 
        "UDP"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "title": "Source ports", 
      "type": "array"
    }
  }, 
  "title": "An NSService element that represents TCP or UDP protocol", 
  "type": "object"
}

Label (type) 

{
  "additionalProperties": false, 
  "description": "Label that will be displayed for a UI element.", 
  "id": "Label", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "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.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "hover": {
      "default": false, 
      "description": "If true, displays the label only on hover", 
      "title": "Show label only on hover", 
      "type": "boolean"
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for the label", 
      "items": {
        "$ref": "Icon"+
      }, 
      "minItems": 0, 
      "title": "Icons", 
      "type": "array"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "text": {
      "description": "Text to be displayed at the label.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Label text", 
      "type": "string"
    }
  }, 
  "title": "Label", 
  "type": "object"
}

LabelValueConfiguration (type) 

{
  "additionalProperties": false, 
  "description": "Represents a Label-Value widget configuration", 
  "extends": {
    "$ref": "WidgetConfiguration"+
  }, 
  "id": "LabelValueConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LabelValueConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "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.", 
      "items": {
        "$ref": "Datasource"+
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "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.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "footer": {
      "$ref": "Footer"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "properties": {
      "description": "An array of label-value properties.", 
      "items": {
        "$ref": "PropertyItem"+
      }, 
      "required": true, 
      "title": "Rows", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Label Value Dashboard Widget Configuration", 
  "type": "object"
}

Lag (type) 

{
  "id": "Lag", 
  "module_id": "UplinkHostSwitchProfile", 
  "properties": {
    "id": {
      "readonly": true, 
      "required": false, 
      "title": "unique id", 
      "type": "string"
    }, 
    "load_balance_algorithm": {
      "enum": [
        "SRCMAC", 
        "DESTMAC", 
        "SRCDESTMAC", 
        "SRCDESTIPVLAN", 
        "SRCDESTMACIPPORT"
      ], 
      "required": true, 
      "title": "LACP load balance Algorithm", 
      "type": "string"
    }, 
    "mode": {
      "enum": [
        "ACTIVE", 
        "PASSIVE"
      ], 
      "required": true, 
      "title": "LACP group mode", 
      "type": "string"
    }, 
    "name": {
      "help_summary": "the max length of the name is 47-byte in UTF-8 encoding", 
      "required": true, 
      "title": "Lag name", 
      "type": "string"
    }, 
    "number_of_uplinks": {
      "maximum": 32, 
      "minimum": 2, 
      "required": true, 
      "title": "number of uplinks", 
      "type": "int"
    }, 
    "timeout_type": {
      "default": "SLOW", 
      "enum": [
        "SLOW", 
        "FAST"
      ], 
      "required": false, 
      "title": "LACP timeout type", 
      "type": "string"
    }, 
    "uplinks": {
      "items": {
        "$ref": "Uplink"+
      }, 
      "maxItems": 32, 
      "readonly": true, 
      "required": false, 
      "title": "uplink names", 
      "type": "array"
    }
  }, 
  "title": "LACP group", 
  "type": "object"
}

LbActiveMonitor (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbMonitor"+
  }, 
  "id": "LbActiveMonitor", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fall_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must fail before marking it down", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the frequency at which the system issues the monitor check (in second)", 
      "type": "integer"
    }, 
    "monitor_port": {
      "$ref": "PortElement"+, 
      "description": "If the monitor port is specified, it would override pool member port\nsetting for healthcheck. A port range is not supported.\n", 
      "required": false, 
      "title": "port which is used for healthcheck"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must pass before marking it up", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the number of seconds the target has in which to respond to the monitor\nrequest\n", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbAppProfile (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbAppProfile", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ApplicationProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbAppProfileListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LbAppProfileListRequestParameters", 
  "module_id": "LoadBalancer", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "$ref": "ApplicationProfileType"+, 
      "description": "Specify this type parameter to retrieve a list of load balancer\napplication profiles of specified type.\n", 
      "required": false, 
      "title": "Load balancer application profile type"
    }
  }, 
  "type": "object"
}

LbAppProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbAppProfileListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbAppProfile"+
      }, 
      "required": true, 
      "title": "paginated list of load balancer application profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbClientCertificateIssuerDnCondition (type) 

{
  "id": "LbClientCertificateIssuerDnCondition", 
  "module_id": "LoadBalancer", 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing issuer DN value.\n", 
      "required": false, 
      "title": "A case sensitive flag for issuer DN comparing", 
      "type": "boolean"
    }, 
    "issuer_dn": {
      "required": true, 
      "title": "Value of issuer DN", 
      "type": "string"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of issuer DN"
    }
  }, 
  "title": "Match condition for client certficate issuer DN", 
  "type": "object"
}

LbClientCertificateSubjectDnCondition (type) 

{
  "id": "LbClientCertificateSubjectDnCondition", 
  "module_id": "LoadBalancer", 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing subject DN value.\n", 
      "required": false, 
      "title": "A case sensitive flag for subject DN comparing", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of subject DN"
    }, 
    "subject_dn": {
      "required": true, 
      "title": "Value of subject DN", 
      "type": "string"
    }
  }, 
  "title": "Match condition for client certficate subject DN", 
  "type": "object"
}

LbClientSslProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbSslProfile"+
  }, 
  "id": "LbClientSslProfile", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "cipher_group_label": {
      "$ref": "SslCipherGroup"+, 
      "description": "It is a label of cipher group which is mostly consumed by GUI.\n", 
      "required": false, 
      "title": "Label of cipher group"
    }, 
    "ciphers": {
      "items": {
        "$ref": "SslCipher"+
      }, 
      "required": false, 
      "title": "supported SSL cipher list to client side", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_fips": {
      "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", 
      "readonly": true, 
      "title": "FIPS compliance of ciphers and protocols", 
      "type": "boolean"
    }, 
    "is_secure": {
      "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", 
      "readonly": true, 
      "title": "Secure/Insecure SSL profile flag", 
      "type": "boolean"
    }, 
    "prefer_server_ciphers": {
      "default": true, 
      "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", 
      "required": false, 
      "title": "prefer server ciphers flag", 
      "type": "boolean"
    }, 
    "protocols": {
      "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", 
      "items": {
        "$ref": "SslProtocol"+
      }, 
      "required": false, 
      "title": "supported SSL protocol list to client side", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "session_cache_enabled": {
      "default": true, 
      "description": "SSL session caching allows SSL client and server to reuse previously\nnegotiated security parameters avoiding the expensive public key\noperation during handshake.\n", 
      "required": false, 
      "title": "session cache enable/disable flag", 
      "type": "boolean"
    }, 
    "session_cache_timeout": {
      "default": 300, 
      "description": "Session cache timeout specifies how long the SSL session parameters\nare held on to and can be reused.\n", 
      "maximum": 86400, 
      "minimum": 1, 
      "required": false, 
      "title": "SSL session cache timeout value", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbClientSslProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbClientSslProfileListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbClientSslProfile"+
      }, 
      "required": true, 
      "title": "paginated list of load balancer client SSL profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbCookiePersistenceProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbPersistenceProfile"+
  }, 
  "id": "LbCookiePersistenceProfile", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbCookiePersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "cookie_domain": {
      "description": "HTTP cookie domain could be configured, only available for insert mode.\n", 
      "required": false, 
      "title": "cookie domain", 
      "type": "string"
    }, 
    "cookie_fallback": {
      "default": true, 
      "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", 
      "required": false, 
      "title": "cookie persistence fallback", 
      "type": "boolean"
    }, 
    "cookie_garble": {
      "default": true, 
      "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", 
      "required": false, 
      "title": "cookie persistence garble", 
      "type": "boolean"
    }, 
    "cookie_mode": {
      "$ref": "CookiePersistenceModeType"+, 
      "default": "INSERT", 
      "required": false, 
      "title": "cookie persistence mode"
    }, 
    "cookie_name": {
      "required": true, 
      "title": "cookie name", 
      "type": "string"
    }, 
    "cookie_path": {
      "description": "HTTP cookie path could be set, only available for insert mode.\n", 
      "required": false, 
      "title": "cookie path", 
      "type": "string"
    }, 
    "cookie_time": {
      "$ref": "LbCookieTime"+, 
      "description": "Both session cookie and persistence cookie are supported, if not\nspecified, it's a session cookie. It expires when the browser is\nclosed.\n", 
      "required": false, 
      "title": "cookie time setting"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "If 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 &lt;name&gt;.&lt;virtual_server_id&gt;.&lt;pool_id&gt;.\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 &lt;name&gt;.&lt;profile-id&gt;.&lt;pool-id&gt;.\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.\n", 
      "required": false, 
      "title": "Persistence shared flag for the associated virtual servers", 
      "type": "boolean"
    }, 
    "resource_type": {
      "$ref": "PersistenceProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbCookieTime (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "id": "LbCookieTime", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "type": {
      "$ref": "CookieTimeType"+, 
      "required": true
    }
  }, 
  "type": "object"
}

LbFastTcpProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbAppProfile"+
  }, 
  "id": "LbFastTcpProfile", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbFastTcpProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "close_timeout": {
      "default": 8, 
      "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", 
      "maximum": 60, 
      "minimum": 1, 
      "required": false, 
      "title": "TCP connection idle timeout in seconds", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "ha_flow_mirroring_enabled": {
      "default": false, 
      "description": "If flow mirroring is enabled, all the flows to the bounded virtual\nserver are mirrored to the standby node.\n", 
      "required": false, 
      "title": "flow mirroring enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 1800, 
      "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", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "TCP connection idle timeout in seconds", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "ApplicationProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbFastUdpProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbAppProfile"+
  }, 
  "id": "LbFastUdpProfile", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbFastUdpProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "flow_mirroring_enabled": {
      "default": false, 
      "description": "If flow mirroring is enabled, all the flows to the bounded virtual\nserver are mirrored to the standby node.\n", 
      "required": false, 
      "title": "flow mirroring enabled flag", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 300, 
      "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", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "UDP idle timeout in seconds", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "ApplicationProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbHttpMonitor (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbActiveMonitor"+
  }, 
  "id": "LbHttpMonitor", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpMonitor"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fall_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must fail before marking it down", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the frequency at which the system issues the monitor check (in second)", 
      "type": "integer"
    }, 
    "monitor_port": {
      "$ref": "PortElement"+, 
      "description": "If the monitor port is specified, it would override pool member port\nsetting for healthcheck. A port range is not supported.\n", 
      "required": false, 
      "title": "port which is used for healthcheck"
    }, 
    "request_body": {
      "required": false, 
      "title": "String to send as part of HTTP health check request body. Valid only\nfor certain HTTP methods like POST.\n", 
      "type": "string"
    }, 
    "request_headers": {
      "items": {
        "$ref": "LbHttpRequestHeader"+
      }, 
      "required": false, 
      "title": "Array of HTTP request headers", 
      "type": "array"
    }, 
    "request_method": {
      "$ref": "HttpRequestMethodType"+, 
      "default": "GET", 
      "required": false, 
      "title": "the health check method for HTTP monitor type"
    }, 
    "request_url": {
      "required": false, 
      "title": "URL used for HTTP monitor", 
      "type": "string"
    }, 
    "request_version": {
      "$ref": "HttpRequestVersionType"+, 
      "default": "HTTP_VERSION_1_1", 
      "required": false, 
      "title": "HTTP request version"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "response_body": {
      "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", 
      "required": false, 
      "title": "response body to match", 
      "type": "string"
    }, 
    "response_status_codes": {
      "description": "The HTTP response status code should be a valid HTTP status code.\n", 
      "items": {
        "type": "int"
      }, 
      "maxItems": 64, 
      "required": false, 
      "title": "Array of single HTTP response status codes", 
      "type": "array"
    }, 
    "rise_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must pass before marking it up", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the number of seconds the target has in which to respond to the monitor\nrequest\n", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbHttpProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbAppProfile"+
  }, 
  "id": "LbHttpProfile", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "http_redirect_to": {
      "description": "If a website is temporarily down or has moved, incoming requests\nfor that virtual server can be temporarily redirected to a URL\n", 
      "required": false, 
      "title": "http redirect static URL", 
      "type": "string"
    }, 
    "http_redirect_to_https": {
      "default": false, 
      "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", 
      "required": false, 
      "title": "flag to indicate whether enable HTTP-HTTPS redirect", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "idle_timeout": {
      "default": 15, 
      "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", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "HTTP application idle timeout in seconds", 
      "type": "integer"
    }, 
    "ntlm": {
      "default": false, 
      "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.\n", 
      "required": false, 
      "title": "NTLM support flag", 
      "type": "boolean"
    }, 
    "request_body_size": {
      "description": "If it is not specified, it means that request body size is unlimited.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum size of the buffer used to store HTTP request body", 
      "type": "integer"
    }, 
    "request_header_size": {
      "default": 1024, 
      "description": "A request with header larger than request_header_size will be processed\nas best effort whereas a request with header below this specified size\nis guaranteed to be processed.\n", 
      "maximum": 65536, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum size of the buffer used to store HTTP request headers", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "ApplicationProfileType"+, 
      "required": true
    }, 
    "response_timeout": {
      "default": 60, 
      "description": "If server doesn't send any packet within this time, the connection is closed.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "Maximum server idle time in seconds", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "x_forwarded_for": {
      "$ref": "XForwardedForType"+, 
      "required": false, 
      "title": "insert or replace x_forwarded_for"
    }
  }, 
  "type": "object"
}

LbHttpRedirectAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbHttpRedirectAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRedirectAction"
  }, 
  "properties": {
    "redirect_status": {
      "required": true, 
      "title": "HTTP response status code", 
      "type": "string"
    }, 
    "redirect_url": {
      "required": true, 
      "title": "The URL that the HTTP request is redirected to", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to redirect HTTP request messages", 
  "type": "object"
}

LbHttpRejectAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbHttpRejectAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRejectAction"
  }, 
  "properties": {
    "reply_message": {
      "required": false, 
      "title": "Response message", 
      "type": "string"
    }, 
    "reply_status": {
      "required": true, 
      "title": "HTTP response status code", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to reject HTTP request messages", 
  "type": "object"
}

LbHttpRequestBodyCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpRequestBodyCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestBodyCondition"
  }, 
  "properties": {
    "body_value": {
      "required": true, 
      "title": "HTTP request body", 
      "type": "string"
    }, 
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing HTTP body value.\n", 
      "required": false, 
      "title": "A case sensitive flag for HTTP body comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of HTTP body"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match content of HTTP request message body", 
  "type": "object"
}

LbHttpRequestCookieCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpRequestCookieCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestCookieCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing cookie value.\n", 
      "required": false, 
      "title": "A case sensitive flag for cookie value comparing", 
      "type": "boolean"
    }, 
    "cookie_name": {
      "required": true, 
      "title": "Name of cookie", 
      "type": "string"
    }, 
    "cookie_value": {
      "required": true, 
      "title": "Value of cookie", 
      "type": "string"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of cookie value"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match HTTP request cookie", 
  "type": "object"
}

LbHttpRequestHeader (type) 

{
  "additionalProperties": false, 
  "id": "LbHttpRequestHeader", 
  "module_id": "LoadBalancer", 
  "properties": {
    "header_name": {
      "required": true, 
      "title": "Name of HTTP request header", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of HTTP request header", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbHttpRequestHeaderCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpRequestHeaderCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestHeaderCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing HTTP header value.\n", 
      "required": false, 
      "title": "A case sensitive flag for HTTP header value comparing", 
      "type": "boolean"
    }, 
    "header_name": {
      "required": true, 
      "title": "Name of HTTP header", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of HTTP header", 
      "type": "string"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of HTTP header value"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match HTTP request header", 
  "type": "object"
}

LbHttpRequestHeaderDeleteAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbHttpRequestHeaderDeleteAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestHeaderDeleteAction"
  }, 
  "properties": {
    "header_name": {
      "required": true, 
      "title": "Name of a header field of HTTP request message", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to delete HTTP request header fields", 
  "type": "object"
}

LbHttpRequestHeaderRewriteAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbHttpRequestHeaderRewriteAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestHeaderRewriteAction"
  }, 
  "properties": {
    "header_name": {
      "required": true, 
      "title": "Name of HTTP request header", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of HTTP request header", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to rewrite header fields of HTTP request messages.", 
  "type": "object"
}

LbHttpRequestMethodCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpRequestMethodCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestMethodCondition"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "method": {
      "$ref": "HttpRequestMethodType"+, 
      "required": true, 
      "title": "Type of HTTP request method"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match method of HTTP request messages", 
  "type": "object"
}

LbHttpRequestUriArgumentsCondition (type) 

{
  "additionalProperties": false, 
  "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=(?&lt;x&gt;\\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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpRequestUriArgumentsCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestUriArgumentsCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing URI arguments.\n", 
      "required": false, 
      "title": "A case sensitive flag for URI arguments comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of URI arguments"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "uri_arguments": {
      "description": "URI arguments, aka query string of URI.\n", 
      "required": true, 
      "title": "URI arguments", 
      "type": "string"
    }
  }, 
  "title": "Condition to match URI arguments of HTTP requests", 
  "type": "object"
}

LbHttpRequestUriCondition (type) 

{
  "additionalProperties": false, 
  "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/(?&lt;year&gt;\\d+)/(?&lt;month&gt;\\d+)/(?&lt;article&gt;.*)\"\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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpRequestUriCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestUriCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing URI.\n", 
      "required": false, 
      "title": "A case sensitive flag for URI comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of URI"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "uri": {
      "required": true, 
      "title": "A string used to identify resource", 
      "type": "string"
    }
  }, 
  "title": "Condition to match URIs of HTTP request messages", 
  "type": "object"
}

LbHttpRequestUriRewriteAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbHttpRequestUriRewriteAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestUriRewriteAction"
  }, 
  "properties": {
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of HTTP request", 
      "type": "string"
    }, 
    "uri_arguments": {
      "description": "Query string of URI, typically contains key value pairs, for example:\nfoo1=bar1&foo2=bar2\n", 
      "required": false, 
      "title": "URI arguments", 
      "type": "string"
    }
  }, 
  "title": "Action to rewrite HTTP request URIs.", 
  "type": "object"
}

LbHttpRequestVersionCondition (type) 

{
  "additionalProperties": false, 
  "description": "This condition is used to match the HTTP protocol version of the HTTP\nrequest messages.\n", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpRequestVersionCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpRequestVersionCondition"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "version": {
      "$ref": "HttpRequestVersionType"+, 
      "required": true, 
      "title": "HTTP version"
    }
  }, 
  "title": "Condition to match HTTP protocol version of HTTP requests", 
  "type": "object"
}

LbHttpResponseHeaderCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpResponseHeaderCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpResponseHeaderCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing HTTP header value.\n", 
      "required": false, 
      "title": "A case sensitive flag for HTTP header value comparing", 
      "type": "boolean"
    }, 
    "header_name": {
      "required": true, 
      "title": "Name of HTTP header field", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of HTTP header field", 
      "type": "string"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of HTTP header value"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match a header field of HTTP response", 
  "type": "object"
}

LbHttpResponseHeaderDeleteAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbHttpResponseHeaderDeleteAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpResponseHeaderDeleteAction"
  }, 
  "properties": {
    "header_name": {
      "required": true, 
      "title": "Name of a header field of HTTP response message", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to delete HTTP response header fields", 
  "type": "object"
}

LbHttpResponseHeaderRewriteAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbHttpResponseHeaderRewriteAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpResponseHeaderRewriteAction"
  }, 
  "properties": {
    "header_name": {
      "required": true, 
      "title": "Name of a header field of HTTP request message", 
      "type": "string"
    }, 
    "header_value": {
      "required": true, 
      "title": "Value of header field", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to rewrite HTTP response header fields", 
  "type": "object"
}

LbHttpSslCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbHttpSslCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpSslCondition"
  }, 
  "properties": {
    "client_certificate_issuer_dn": {
      "$ref": "LbClientCertificateIssuerDnCondition"+, 
      "description": "The issuer DN match condition of the client certificate for an\nestablished SSL connection\n", 
      "required": false, 
      "title": "The issuer DN match condition of the client certificate"
    }, 
    "client_certificate_subject_dn": {
      "$ref": "LbClientCertificateSubjectDnCondition"+, 
      "description": "The subject DN match condition of the client certificate for an\nestablished SSL connection\n", 
      "required": false, 
      "title": "The subject DN match condition of the client certificate"
    }, 
    "client_supported_ssl_ciphers": {
      "items": {
        "$ref": "SslCipher"+
      }, 
      "required": false, 
      "title": "Cipher list which supported by client", 
      "type": "array"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "session_reused": {
      "$ref": "LbSslSessionReusedType"+, 
      "default": "IGNORE", 
      "required": false, 
      "title": "The type of SSL session reused"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "used_protocol": {
      "$ref": "SslProtocol"+, 
      "required": false, 
      "title": "Protocol of an established SSL connection"
    }, 
    "used_ssl_cipher": {
      "$ref": "SslCipher"+, 
      "required": false, 
      "title": "Cipher used for an established SSL connection"
    }
  }, 
  "title": "Condition to match SSL handshake and SSL connection", 
  "type": "object"
}

LbHttpsMonitor (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbActiveMonitor"+
  }, 
  "id": "LbHttpsMonitor", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbHttpsMonitor"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "certificate_chain_depth": {
      "default": 3, 
      "description": "authentication depth is used to set the verification depth in the server\ncertificates chain.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the maximum traversal depth of server certificate chain", 
      "type": "integer"
    }, 
    "cipher_group_label": {
      "$ref": "SslCipherGroup"+, 
      "description": "It is a label of cipher group which is mostly consumed by GUI.\n", 
      "required": false, 
      "title": "Label of cipher group"
    }, 
    "ciphers": {
      "items": {
        "$ref": "SslCipher"+
      }, 
      "required": false, 
      "title": "supported SSL cipher list to servers", 
      "type": "array"
    }, 
    "client_certificate_id": {
      "description": "client certificate can be specified to support client authentication.\n", 
      "required": false, 
      "title": "client certificate identifier", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fall_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must fail before marking it down", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the frequency at which the system issues the monitor check (in second)", 
      "type": "integer"
    }, 
    "is_fips": {
      "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", 
      "readonly": true, 
      "title": "FIPS compliance of ciphers and protocols", 
      "type": "boolean"
    }, 
    "is_secure": {
      "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", 
      "readonly": true, 
      "title": "Secure/Insecure monitor flag", 
      "type": "boolean"
    }, 
    "monitor_port": {
      "$ref": "PortElement"+, 
      "description": "If the monitor port is specified, it would override pool member port\nsetting for healthcheck. A port range is not supported.\n", 
      "required": false, 
      "title": "port which is used for healthcheck"
    }, 
    "protocols": {
      "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", 
      "items": {
        "$ref": "SslProtocol"+
      }, 
      "required": false, 
      "title": "supported SSL protocol list to servers", 
      "type": "array"
    }, 
    "request_body": {
      "required": false, 
      "title": "String to send as part of HTTP health check request body. Valid only\nfor certain HTTP methods like POST.\n", 
      "type": "string"
    }, 
    "request_headers": {
      "items": {
        "$ref": "LbHttpRequestHeader"+
      }, 
      "required": false, 
      "title": "Array of HTTP request headers", 
      "type": "array"
    }, 
    "request_method": {
      "$ref": "HttpRequestMethodType"+, 
      "default": "GET", 
      "required": false, 
      "title": "the health check method for HTTP monitor type"
    }, 
    "request_url": {
      "required": false, 
      "title": "URL used for HTTP monitor", 
      "type": "string"
    }, 
    "request_version": {
      "$ref": "HttpRequestVersionType"+, 
      "default": "HTTP_VERSION_1_1", 
      "required": false, 
      "title": "HTTP request version"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "response_body": {
      "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", 
      "required": false, 
      "title": "response body to match", 
      "type": "string"
    }, 
    "response_status_codes": {
      "description": "The HTTP response status code should be a valid HTTP status code.\n", 
      "items": {
        "type": "int"
      }, 
      "maxItems": 64, 
      "required": false, 
      "title": "Array of single HTTP response status codes", 
      "type": "array"
    }, 
    "rise_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must pass before marking it up", 
      "type": "integer"
    }, 
    "server_auth": {
      "$ref": "ServerAuthType"+, 
      "default": "IGNORE", 
      "title": "server authentication mode"
    }, 
    "server_auth_ca_ids": {
      "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", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CA identifier list to verify server certificate", 
      "type": "array"
    }, 
    "server_auth_crl_ids": {
      "description": "A Certificate Revocation List (CRL) can be specified in the server-side\nSSL profile binding to disallow compromised server certificates.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CRL identifier list to verify server certificate", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the number of seconds the target has in which to respond to the monitor\nrequest\n", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbIcmpMonitor (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbActiveMonitor"+
  }, 
  "id": "LbIcmpMonitor", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbIcmpMonitor"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "data_length": {
      "default": 56, 
      "maximum": 65507, 
      "minimum": 0, 
      "required": false, 
      "title": "The data size(in byte) of the ICMP healthcheck packet", 
      "type": "integer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fall_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must fail before marking it down", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the frequency at which the system issues the monitor check (in second)", 
      "type": "integer"
    }, 
    "monitor_port": {
      "$ref": "PortElement"+, 
      "description": "If the monitor port is specified, it would override pool member port\nsetting for healthcheck. A port range is not supported.\n", 
      "required": false, 
      "title": "port which is used for healthcheck"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must pass before marking it up", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the number of seconds the target has in which to respond to the monitor\nrequest\n", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbIpHeaderCondition (type) 

{
  "additionalProperties": false, 
  "description": "This condition is used to match IP header fields of HTTP messages.\nCurrently, only the source IP address is supported. IP addresses can be\nexpressed as a single IP address like 10.1.1.1, or a range of IP addresses\nlike 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.\n", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbIpHeaderCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbIpHeaderCondition"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "source_address": {
      "$ref": "IPElement"+, 
      "required": true, 
      "title": "Source IP address of HTTP message"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match IP header fields", 
  "type": "object"
}

LbLogLevel (type) 

{
  "additionalProperties": false, 
  "enum": [
    "DEBUG", 
    "INFO", 
    "WARNING", 
    "ERROR", 
    "CRITICAL", 
    "ALERT", 
    "EMERGENCY"
  ], 
  "id": "LbLogLevel", 
  "module_id": "LoadBalancer", 
  "title": "the log level of load balancer service", 
  "type": "string"
}

LbMonitor (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbMonitor", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbMonitorListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LbMonitorListRequestParameters", 
  "module_id": "LoadBalancer", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "$ref": "MonitorQueryType"+, 
      "description": "Specify this type parameter to retrieve a list of load balancer\nmonitors of specified type.\n", 
      "required": false, 
      "title": "Load balancer monitor type"
    }
  }, 
  "type": "object"
}

LbMonitorListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbMonitorListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbMonitor"+
      }, 
      "required": true, 
      "title": "paginated list of load balancer monitors", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbPassiveMonitor (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbMonitor"+
  }, 
  "id": "LbPassiveMonitor", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbPassiveMonitor"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "max_fails": {
      "default": 5, 
      "description": "When the consecutive failures reach this value, then the member is\nconsidered temporarily unavailable for a configurable period\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "number of consecutive connection failures", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 5, 
      "description": "After this timeout period, the member is tried again for a new\nconnection to see if it is available.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "timeout in seconds before it is selected again for a new connection", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbPersistenceCookieTime (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbCookieTime"+
  }, 
  "id": "LbPersistenceCookieTime", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbPersistenceCookieTime"
  }, 
  "properties": {
    "cookie_max_idle": {
      "description": "HTTP cookie max-age to expire cookie, only available for insert mode.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": true, 
      "title": "persistence cookie max idle time in seconds", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "CookieTimeType"+, 
      "required": true
    }
  }, 
  "type": "object"
}

LbPersistenceProfile (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbPersistenceProfile", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "If 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 &lt;name&gt;.&lt;virtual_server_id&gt;.&lt;pool_id&gt;.\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 &lt;name&gt;.&lt;profile-id&gt;.&lt;pool-id&gt;.\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.\n", 
      "required": false, 
      "title": "Persistence shared flag for the associated virtual servers", 
      "type": "boolean"
    }, 
    "resource_type": {
      "$ref": "PersistenceProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbPersistenceProfileListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LbPersistenceProfileListRequestParameters", 
  "module_id": "LoadBalancer", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "$ref": "PersistenceProfileType"+, 
      "description": "Specify this type parameter to retrieve a list of load balancer\npersistence profiles of specified type.\n", 
      "required": false, 
      "title": "Load balancer persistence profile type"
    }
  }, 
  "type": "object"
}

LbPersistenceProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbPersistenceProfileListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbPersistenceProfile"+
      }, 
      "required": true, 
      "title": "paginated list of load balancer persistence profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbPool (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbPool", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "active_monitor_ids": {
      "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. Currently, only one active\nhealth monitor can be configured per server pool.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "active monitor identifier list", 
      "type": "array"
    }, 
    "algorithm": {
      "$ref": "PoolAlgorithm"+, 
      "default": "ROUND_ROBIN", 
      "description": "Load balancing algorithm, configurable per pool controls how the\nincoming connections are distributed among the members.\n", 
      "required": false, 
      "title": "pool balancing algorithm for backend pool members"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "member_group": {
      "$ref": "PoolMemberGroup"+, 
      "description": "Load balancer pool support grouping object as dynamic pool members.\nWhen member group is defined, members setting should not be specified.\n", 
      "required": false, 
      "title": "Load balancer member setting with grouping object"
    }, 
    "members": {
      "description": "Server pool consists of one or more pool members. Each pool member\nis identified, typically, by an IP address and a port.\n", 
      "items": {
        "$ref": "PoolMember"+
      }, 
      "required": false, 
      "title": "load balancer pool members", 
      "type": "array"
    }, 
    "min_active_members": {
      "default": 1, 
      "description": "A pool is considered active if there are at least certain\nminimum number of members.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "minimum number of active pool members to consider pool as active", 
      "type": "integer"
    }, 
    "passive_monitor_id": {
      "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.\n", 
      "required": false, 
      "title": "passive monitor identifier", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "snat_translation": {
      "$ref": "LbSnatTranslation"+, 
      "description": "Depending on the topology, Source NAT (SNAT) may be required to ensure\ntraffic from the server destined to the client is received by the load\nbalancer. SNAT can be enabled per pool. If SNAT is not enabled for a\npool, then load balancer uses the client IP and port (spoofing) while\nestablishing connections to the servers. This is referred to as no-SNAT\nor TRANSPARENT mode.\n", 
      "required": false, 
      "title": "snat translation configuration"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_multiplexing_enabled": {
      "default": false, 
      "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.\n", 
      "required": false, 
      "title": "TCP multiplexing enable flag", 
      "type": "boolean"
    }, 
    "tcp_multiplexing_number": {
      "default": 6, 
      "description": "The maximum number of TCP connections per pool that are idly kept alive\nfor sending future client requests.\n", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "required": false, 
      "title": "maximum number of TCP connections for multiplexing", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbPoolListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LbPoolListRequestParameters", 
  "module_id": "UILb", 
  "properties": {
    "active_monitor_id": {
      "title": "Active monitor id specified to filter corresponding pools", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "passive_monitor_id": {
      "title": "Passive monitor id specified to filter corresponding pools", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbPoolListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbPoolListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbPool"+
      }, 
      "required": true, 
      "title": "paginated list of pools", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbPoolMemberStatistics (type) 

{
  "id": "LbPoolMemberStatistics", 
  "module_id": "AggSvcLb", 
  "properties": {
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "Pool member IP address"
    }, 
    "port": {
      "$ref": "PortElement"+, 
      "description": "The port is configured in pool member. For virtual server port range\ncase, pool member port must be null.\n", 
      "title": "Pool member port"
    }, 
    "statistics": {
      "$ref": "LbStatisticsCounter"+, 
      "required": true, 
      "title": "Pool member statistics counter"
    }
  }, 
  "type": "object"
}

LbPoolMemberStatus (type) 

{
  "id": "LbPoolMemberStatus", 
  "module_id": "AggSvcLb", 
  "properties": {
    "failure_cause": {
      "title": "The healthcheck failure cause when status is DOWN", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "Pool member IP address"
    }, 
    "last_check_time": {
      "$ref": "EpochMsTimestamp"+, 
      "titile": "Timestamp when the monitor status was last checked"
    }, 
    "last_state_change_time": {
      "$ref": "EpochMsTimestamp"+, 
      "titile": "Timestamp when the monitor status was last changed"
    }, 
    "port": {
      "$ref": "PortElement"+, 
      "description": "The port is configured in pool member. For virtual server port range\ncase, pool member port must be null.\n", 
      "title": "Pool member port"
    }, 
    "status": {
      "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.\n", 
      "enum": [
        "UP", 
        "DOWN", 
        "DISABLED", 
        "GRACEFUL_DISABLED", 
        "UNUSED"
      ], 
      "required": true, 
      "title": "Pool member status", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbPoolStatistics (type) 

{
  "id": "LbPoolStatistics", 
  "module_id": "AggSvcLb", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "title": "Timestamp when the data was last updated"
    }, 
    "members": {
      "items": {
        "$ref": "LbPoolMemberStatistics"+
      }, 
      "title": "Statistics of load balancer pool members", 
      "type": "array"
    }, 
    "pool_id": {
      "required": true, 
      "title": "Load balancer pool identifier", 
      "type": "string"
    }, 
    "statistics": {
      "$ref": "LbStatisticsCounter"+, 
      "required": true, 
      "title": "Virtual server statistics counter"
    }
  }, 
  "type": "object"
}

LbPoolStatisticsListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbPoolStatisticsListResult", 
  "module_id": "AggSvcLb", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbPoolStatistics"+
      }, 
      "required": true, 
      "title": "paginated statistics list of pools", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbPoolStatus (type) 

{
  "id": "LbPoolStatus", 
  "module_id": "AggSvcLb", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "title": "Timestamp when the data was last updated"
    }, 
    "members": {
      "items": {
        "$ref": "LbPoolMemberStatus"+
      }, 
      "title": "Status of load balancer pool members", 
      "type": "array"
    }, 
    "pool_id": {
      "required": true, 
      "title": "Load balancer pool identifier", 
      "type": "string"
    }, 
    "status": {
      "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.\nUNKOWN means that no status reported from transport-nodes. The\nassociated load balancer service may be working(or not working).\n", 
      "enum": [
        "UP", 
        "PARTIALLY_UP", 
        "PRIMARY_DOWN", 
        "DOWN", 
        "DETACHED", 
        "UNKNOWN"
      ], 
      "title": "Virtual server status", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbPoolStatusListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbPoolStatusListResult", 
  "module_id": "AggSvcLb", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbPoolStatus"+
      }, 
      "required": true, 
      "title": "paginated status list of pools", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbRule (type) 

{
  "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", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbRule", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "actions": {
      "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", 
      "items": {
        "$ref": "LbRuleAction"+
      }, 
      "maxItems": 60, 
      "required": true, 
      "title": "Actions to be executed", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "match_conditions": {
      "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", 
      "items": {
        "$ref": "LbRuleCondition"+
      }, 
      "maxItems": 60, 
      "required": false, 
      "title": "Conditions to match application traffic", 
      "type": "array"
    }, 
    "match_strategy": {
      "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", 
      "enum": [
        "ALL", 
        "ANY"
      ], 
      "required": true, 
      "title": "Strategy to match multiple conditions", 
      "type": "string"
    }, 
    "phase": {
      "description": "Each 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.\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.\n", 
      "enum": [
        "HTTP_REQUEST_REWRITE", 
        "HTTP_FORWARDING", 
        "HTTP_RESPONSE_REWRITE"
      ], 
      "required": true, 
      "title": "Load balancer processing phase", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Load balancer rules", 
  "type": "object"
}

LbRuleAction (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "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\nSupported action in HTTP_RESPONSE_REWRITE phase is:\n  LbHttpResponseHeaderRewriteAction\n  LbHttpResponseHeaderDeleteAction\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/(?&lt;year&gt;\\d+)/(?&lt;month&gt;\\d+)/(?&lt;article&gt;.*)\".\nSet uri field of LbHttpRequestUriRewriteAction to:\n  \"/news/$year-$month/$article\"\nIn uri field of LbHttpRequestUriCondition, the (?&lt;year&gt;\\d+),\n(?&lt;month&gt;\\d+) and (?&lt;article&gt;.*) 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", 
  "id": "LbRuleAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Load balancer rule action", 
  "type": "object"
}

LbRuleActionType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "LbHttpRequestUriRewriteAction", 
    "LbHttpRequestHeaderRewriteAction", 
    "LbHttpRejectAction", 
    "LbHttpRedirectAction", 
    "LbSelectPoolAction", 
    "LbSelectServerAction", 
    "LbHttpResponseHeaderRewriteAction", 
    "LbHttpRequestHeaderDeleteAction", 
    "LbHttpResponseHeaderDeleteAction", 
    "LbVariableAssignmentAction"
  ], 
  "id": "LbRuleActionType", 
  "module_id": "LoadBalancer", 
  "title": "Types of load balancer rule actions", 
  "type": "string"
}

LbRuleCondition (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "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\nLbHttpRequestVersionCondition\nLbHttpRequestHeaderCondition\nLbHttpRequestCookieCondition\nLbHttpRequestBodyCondition\nLbTcpHeaderCondition\nLbIpHeaderCondition\nLbVariableCondition\nLbHttpSslCondition\nSupported match condition in HTTP_RESPONSE_REWRITE phase is:\nLbHttpResponseHeaderCondition\nLbHttpRequestMethodCondition\nLbHttpRequestUriCondition\nLbHttpRequestUriArgumentsCondition\nLbHttpRequestVersionCondition\nLbHttpRequestHeaderCondition\nLbHttpRequestCookieCondition\nLbTcpHeaderCondition\nLbIpHeaderCondition\nLbVariableCondition\nLbHttpSslCondition\n", 
  "id": "LbRuleCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Match condition of load balancer rule", 
  "type": "object"
}

LbRuleConditionType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "LbHttpRequestMethodCondition", 
    "LbHttpRequestUriCondition", 
    "LbHttpRequestUriArgumentsCondition", 
    "LbHttpRequestVersionCondition", 
    "LbHttpRequestHeaderCondition", 
    "LbHttpRequestCookieCondition", 
    "LbHttpRequestBodyCondition", 
    "LbHttpResponseHeaderCondition", 
    "LbTcpHeaderCondition", 
    "LbIpHeaderCondition", 
    "LbVariableCondition", 
    "LbHttpSslCondition"
  ], 
  "id": "LbRuleConditionType", 
  "module_id": "LoadBalancer", 
  "title": "Type of load balancer rule match condition", 
  "type": "string"
}

LbRuleListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbRuleListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbRule"+
      }, 
      "required": true, 
      "title": "paginated list of LB rules", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbRuleMatchType (type) 

{
  "additionalProperties": false, 
  "description": "LbRuleMatchType is used to determine how a specified string value is used\nto match a specified LbRuleCondition field.\nSTARTS_WITH: If the LbRuleCondition field starts with specified string, the\ncondition matches. The fields with this match type are specified as\nstrings, not regular expressions.\nENDS_WITH: If the LbRuleCondition field ends with specified string, the\ncondition matches. The fields with this match type are specified as\nstrings, not regular expressions.\nEQUALS: If the LbRuleCondition field is same as the specified string, the\ncondition matches. The fields with this match type are specified as\nstrings, not regular expressions.\nCONTAINS: If the LbRuleCondition field contains the specified string, the\ncondition matches. The fields with this match type are specified as\nstrings, not regular expressions.\nREGEX: If the LbRuleCondition field matches specified regular expression,\nthe condition matches. The regular expressions in load balancer rules use\nthe features common to both Java regular expressions and Perl Compatible\nRegular Expressions (PCREs) with some restrictions. Reference\nhttp://www.pcre.org for PCRE and the NSX-T Administrator's Guide for the\nrestrictions.\nIf named capturing groups are used in the regular expression, when a\nmatch succeeds, the substrings of the subject string that match named\ncapturing groups are stored (captured) in variables with specific names\nwhich can be used in the fields of LbRuleAction which support variables.\nNamed capturing group are defined in the format (?&lt;name&gt;subpattern),\nsuch as (?&lt;year&gt;\\d{4}).\nFor example, in the regular expression:\n\"/news/(?&lt;year&gt;\\d+)/(?&lt;month&gt;\\d+)/(?&lt;article&gt;.*)\", for\nsubject string \"/news/2017/06/xyz.html\", the substring \"2017\" is captured\nin variable year, \"06\" is captured in variable month, and \"xyz.html\" is\ncaptured in variable article. These variables can be used in LbRuleAction\nfields which support variables in form of $name, such as $year, $month,\n$article.\nPlease note, when regular expressions are used in JSON(JavaScript Object\nNotation) string, every backslash character (\\) needs to be escaped by one\nadditional backslash character.\n", 
  "enum": [
    "STARTS_WITH", 
    "ENDS_WITH", 
    "EQUALS", 
    "CONTAINS", 
    "REGEX"
  ], 
  "id": "LbRuleMatchType", 
  "module_id": "LoadBalancer", 
  "title": "Match type for LbRule conditions", 
  "type": "string"
}

LbSelectPoolAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbSelectPoolAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbSelectPoolAction"
  }, 
  "properties": {
    "pool_id": {
      "required": true, 
      "title": "UUID of load balancer pool", 
      "type": "string"
    }, 
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }
  }, 
  "title": "Action to select a pool for HTTP request messages", 
  "type": "object"
}

LbServerSslProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbSslProfile"+
  }, 
  "id": "LbServerSslProfile", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "cipher_group_label": {
      "$ref": "SslCipherGroup"+, 
      "description": "It is a label of cipher group which is mostly consumed by GUI.\n", 
      "required": false, 
      "title": "Label of cipher group"
    }, 
    "ciphers": {
      "items": {
        "$ref": "SslCipher"+
      }, 
      "required": false, 
      "title": "supported SSL cipher list to client side", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_fips": {
      "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", 
      "readonly": true, 
      "title": "FIPS compliance of ciphers and protocols", 
      "type": "boolean"
    }, 
    "is_secure": {
      "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", 
      "readonly": true, 
      "title": "Secure/Insecure SSL profile flag", 
      "type": "boolean"
    }, 
    "protocols": {
      "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", 
      "items": {
        "$ref": "SslProtocol"+
      }, 
      "required": false, 
      "title": "supported SSL protocol list to client side", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "session_cache_enabled": {
      "default": true, 
      "description": "SSL session caching allows SSL client and server to reuse previously\nnegotiated security parameters avoiding the expensive public key\noperation during handshake.\n", 
      "required": false, 
      "title": "session cache enable/disable falg", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbServerSslProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbServerSslProfileListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbServerSslProfile"+
      }, 
      "required": true, 
      "title": "paginated list of load balancer server SSL profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbService (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbService", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "deprecated": true, 
      "details": "This is a deprecated property, please use 'access_log_enabled' in\nLbVirtualServer. If both virtual server and load balancer service have\nthe setting, the setting in virtual server layer would override it and\ntake effect.\nIf access log is enabled, all HTTP requests sent to a L7 virtual server\nare logged to the access log file. L4 virtual server connections are\nnot currently logged to the access log.\n", 
      "required": false, 
      "title": "whether access log is enabled", 
      "type": "boolean"
    }, 
    "attachment": {
      "$ref": "ResourceReference"+, 
      "description": "LBS could be instantiated (or created) on the Logical router, etc.\nTypically, it could be applied to Tier1 LogicalRouter. It can be\nattached to Tier0 LogicalRouter either in non-multi-tenant environments\nor to provide load balancing for infrastructure services offered by\nthe provider.\n", 
      "required": false, 
      "title": "The target which is used to instantiate Lb service."
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "whether the load balancer service is enabled", 
      "type": "boolean"
    }, 
    "error_log_level": {
      "$ref": "LbLogLevel"+, 
      "default": "INFO", 
      "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", 
      "required": false, 
      "title": "Error log level of load balancer service"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "size": {
      "$ref": "LbServiceSize"+, 
      "default": "SMALL", 
      "required": false, 
      "title": "the size of load balancer service"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "virtual_server_ids": {
      "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", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "virtual server identifier list", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbServiceListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LbServiceListRequestParameters", 
  "module_id": "UILb", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "virtual_server_id": {
      "title": "Virtual server identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbServiceListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbServiceListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbService"+
      }, 
      "required": true, 
      "title": "paginated list of load balancer services", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbServiceQueryRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LbServiceQueryRequestParameters", 
  "module_id": "LoadBalancer", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "logical_router_id": {
      "description": "When logical_router_id is specified, the list load balancer API will\nreturn the load balancer services which are related to the given\nlogical router.\n", 
      "title": "Logical router identifier", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Load balancer service list request parameters", 
  "type": "object"
}

LbServiceSize (type) 

{
  "additionalProperties": false, 
  "description": "To address varied customer performance and scalability requirements,\ndifferent sizes for load balancer service are supported:\nLARGE, MEDIUM and SMALL, each with its own set of resource and performance\nspecifications.\n", 
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "LARGE"
  ], 
  "id": "LbServiceSize", 
  "module_id": "LoadBalancer", 
  "title": "the size of load balancer service", 
  "type": "string"
}

LbSessionCookieTime (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbCookieTime"+
  }, 
  "id": "LbSessionCookieTime", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbSessionCookieTime"
  }, 
  "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", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "session cookie max idle time in seconds", 
      "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", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "session cookie max lifetime in seconds", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "CookieTimeType"+, 
      "required": true
    }
  }, 
  "type": "object"
}

LbSnatAutoMap (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbSnatTranslation"+
  }, 
  "id": "LbSnatAutoMap", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbSnatAutoMap"
  }, 
  "properties": {
    "port_overload": {
      "default": 32, 
      "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.\n", 
      "maximum": 32, 
      "minimum": 1, 
      "required": false, 
      "title": "port overloading with same SNAT IP and port", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "SnatTranslationType"+, 
      "required": true
    }
  }, 
  "type": "object"
}

LbSnatIpElement (type) 

{
  "id": "LbSnatIpElement", 
  "module_id": "LoadBalancer", 
  "properties": {
    "ip_address": {
      "$ref": "IPElement"+, 
      "required": true, 
      "title": "Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160"
    }, 
    "prefix_length": {
      "description": "Subnet prefix length should be not specified if there is only one single\nIP address or IP range.\n", 
      "required": false, 
      "title": "subnet prefix length", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbSnatIpPool (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbSnatTranslation"+
  }, 
  "id": "LbSnatIpPool", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbSnatIpPool"
  }, 
  "properties": {
    "ip_addresses": {
      "description": "If an IP range is specified, the range may contain no more than 64\nIP addresses.\n", 
      "items": {
        "$ref": "LbSnatIpElement"+
      }, 
      "maxItems": 64, 
      "required": true, 
      "title": "List of Ip address or ip range", 
      "type": "array"
    }, 
    "port_overload": {
      "default": 32, 
      "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.\n", 
      "maximum": 32, 
      "minimum": 1, 
      "required": false, 
      "title": "port overloading with same SNAT IP and port", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "SnatTranslationType"+, 
      "required": true
    }
  }, 
  "type": "object"
}

LbSnatTranslation (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "id": "LbSnatTranslation", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "type"
  }, 
  "properties": {
    "port_overload": {
      "default": 32, 
      "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.\n", 
      "maximum": 32, 
      "minimum": 1, 
      "required": false, 
      "title": "port overloading with same SNAT IP and port", 
      "type": "integer"
    }, 
    "type": {
      "$ref": "SnatTranslationType"+, 
      "required": true
    }
  }, 
  "type": "object"
}

LbSourceIpPersistenceProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbPersistenceProfile"+
  }, 
  "id": "LbSourceIpPersistenceProfile", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbSourceIpPersistenceProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "ha_persistence_mirroring_enabled": {
      "default": false, 
      "description": "Persistence entries are not synchronized to the HA peer by default.\n", 
      "required": false, 
      "title": "mirroring enabled flag to synchronize persistence entries", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "persistence_shared": {
      "default": false, 
      "description": "If 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 &lt;name&gt;.&lt;virtual_server_id&gt;.&lt;pool_id&gt;.\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 &lt;name&gt;.&lt;profile-id&gt;.&lt;pool-id&gt;.\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.\n", 
      "required": false, 
      "title": "Persistence shared flag for the associated virtual servers", 
      "type": "boolean"
    }, 
    "purge": {
      "$ref": "SourceIpPersistencePurge"+, 
      "default": "FULL", 
      "required": false, 
      "title": "persistence purge setting"
    }, 
    "resource_type": {
      "$ref": "PersistenceProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 300, 
      "description": "When all connections complete (reference count reaches 0), persistence\nentry timer is started with the expiration time.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "persistence entry expiration time in seconds", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbSslCipherAndProtocolListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbSslCipherAndProtocolListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "ciphers": {
      "items": {
        "$ref": "LbSslCipherInfo"+
      }, 
      "required": true, 
      "title": "List of SSL ciphers", 
      "type": "array"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "protocols": {
      "items": {
        "$ref": "LbSslProtocolInfo"+
      }, 
      "required": true, 
      "title": "List of SSL protocols", 
      "type": "array"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbSslCipherInfo (type) 

{
  "additionalProperties": false, 
  "id": "LbSslCipherInfo", 
  "module_id": "LoadBalancer", 
  "properties": {
    "cipher": {
      "$ref": "SslCipher"+, 
      "required": true, 
      "title": "SSL cipher"
    }, 
    "cipher_group_labels": {
      "description": "Several cipher groups might contain the same cipher suite, each cipher\nsuite could have multiple cipher group labels.\n", 
      "items": {
        "$ref": "SslCipherGroup"+
      }, 
      "title": "Cipher group label list", 
      "type": "array"
    }, 
    "is_default": {
      "required": true, 
      "title": "Default SSL cipher flag", 
      "type": "boolean"
    }, 
    "is_secure": {
      "required": true, 
      "title": "Secure/insecure SSL cipher flag", 
      "type": "boolean"
    }
  }, 
  "title": "SSL cipher", 
  "type": "object"
}

LbSslProfile (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbSslProfile", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Load balancer abstract SSL profile", 
  "type": "object"
}

LbSslProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbSslProfileListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbSslProfile"+
      }, 
      "required": true, 
      "title": "paginated list of load balancer SSL profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbSslProtocolInfo (type) 

{
  "additionalProperties": false, 
  "id": "LbSslProtocolInfo", 
  "module_id": "LoadBalancer", 
  "properties": {
    "is_default": {
      "required": true, 
      "title": "Default SSL protocol flag", 
      "type": "boolean"
    }, 
    "is_secure": {
      "required": true, 
      "title": "Secure/insecure SSL protocol flag", 
      "type": "boolean"
    }, 
    "protocol": {
      "$ref": "SslProtocol"+, 
      "required": true, 
      "title": "SSL protocol"
    }
  }, 
  "title": "SSL protocol", 
  "type": "object"
}

LbSslSessionReusedType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "IGNORE", 
    "REUSED", 
    "NEW"
  ], 
  "id": "LbSslSessionReusedType", 
  "module_id": "LoadBalancer", 
  "title": "Type of SSL session reused", 
  "type": "string"
}

LbStatisticsCounter (type) 

{
  "id": "LbStatisticsCounter", 
  "module_id": "AggSvcLb", 
  "properties": {
    "bytes_in": {
      "required": true, 
      "title": "Number of bytes in", 
      "type": "integer"
    }, 
    "bytes_in_rate": {
      "title": "The average number of inbound bytes per second, the number is\naveraged over the last 5 one-second intervals.\n", 
      "type": "number"
    }, 
    "bytes_out": {
      "required": true, 
      "title": "Number of bytes out", 
      "type": "integer"
    }, 
    "bytes_out_rate": {
      "title": "The average number of outbound bytes per second, the number is\naveraged over the last 5 one-second intervals.\n", 
      "type": "number"
    }, 
    "current_session_rate": {
      "title": "The average number of current sessions per second, the number is\naveraged over the last 5 one-second intervals.\n", 
      "type": "number"
    }, 
    "current_sessions": {
      "required": true, 
      "title": "Number of current sessions", 
      "type": "integer"
    }, 
    "http_request_rate": {
      "title": "The average number of http requests per second, the number is\naveraged over the last 5 one-second intervals.\n", 
      "type": "number"
    }, 
    "http_requests": {
      "title": "The total number of http requests.", 
      "type": "integer"
    }, 
    "max_sessions": {
      "required": true, 
      "title": "Number of maximum sessions", 
      "type": "integer"
    }, 
    "packets_in": {
      "title": "Number of packets in", 
      "type": "integer"
    }, 
    "packets_in_rate": {
      "title": "The average number of inbound packets per second, the number is\naveraged over the last 5 one-second intervals.\n", 
      "type": "number"
    }, 
    "packets_out": {
      "title": "Number of packets out", 
      "type": "integer"
    }, 
    "packets_out_rate": {
      "title": "The average number of outbound packets per second, the number is\naveraged over the last 5 one-second intervals.\n", 
      "type": "number"
    }, 
    "source_ip_persistence_entry_size": {
      "title": "Number of source IP persistence entries", 
      "type": "integer"
    }, 
    "total_sessions": {
      "required": true, 
      "title": "Number of total sessions", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbTcpHeaderCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbTcpHeaderCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbTcpHeaderCondition"
  }, 
  "properties": {
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "source_port": {
      "$ref": "PortElement"+, 
      "required": true, 
      "title": "TCP source port of HTTP message"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }
  }, 
  "title": "Condition to match TCP header fields", 
  "type": "object"
}

LbTcpMonitor (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbActiveMonitor"+
  }, 
  "id": "LbTcpMonitor", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbTcpMonitor"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fall_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must fail before marking it down", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the frequency at which the system issues the monitor check (in second)", 
      "type": "integer"
    }, 
    "monitor_port": {
      "$ref": "PortElement"+, 
      "description": "If the monitor port is specified, it would override pool member port\nsetting for healthcheck. A port range is not supported.\n", 
      "required": false, 
      "title": "port which is used for healthcheck"
    }, 
    "receive": {
      "description": "Expected data, if specified, can be anywhere in the response and it has to\nbe a string, regular expressions are not supported.\n", 
      "required": false, 
      "title": "expected data received from server", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must pass before marking it up", 
      "type": "integer"
    }, 
    "send": {
      "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", 
      "required": false, 
      "title": "data to send", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the number of seconds the target has in which to respond to the monitor\nrequest\n", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbTcpProfile (type) 

{
  "additionalProperties": false, 
  "description": "TCP profile allows customization of TCP stack behavior for each\napplication. As TCP connections are terminated (or initiated) on the load\nbalancer only for L7 virtual servers, TCP profiles are applicable only to\nthem. As the desired TCP characteristics (e.g. Rx/Tx buffers) may be\ndifferent for client (typically on WAN) and server (typically on LAN)\nsides, two separate profiles can be bound to virtual server, one for\nclient-side (LbVirtualServer.client_tcp_profile_id) and another for\nserver-side (LbVirtualServer.server_tcp_profile_id).\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbTcpProfile", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fin_wait2_timeout": {
      "description": "If the field is not specified, the load balancer will use the default\nsetting per load balancer service flavor.\n", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "required": false, 
      "title": "Sets how long TCP connections in FIN_WAIT2 state are kept.", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "max_syn_retransmissions": {
      "description": "If the field is not specified, the load balancer will use the default\nsetting per load balancer service flavor.\n", 
      "maximum": 127, 
      "minimum": 1, 
      "required": false, 
      "title": "Sets the max number of times TCP SYN is retransmitted before failing an\nattempt to connect.\n", 
      "type": "integer"
    }, 
    "nagle_algorithm_enabled": {
      "default": true, 
      "required": false, 
      "title": "Setting this option to enable or disable Nagle's algorithm.", 
      "type": "boolean"
    }, 
    "receive_window_size": {
      "description": "If the field is not specified, the load balancer will use the default\nsetting per load balancer service flavor.\n", 
      "maximum": 2147483647, 
      "minimum": 1024, 
      "required": false, 
      "title": "Sets max TCP receive buffer, specified in bytes.", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transmit_window_size": {
      "description": "If the field is not specified, the load balancer will use the default\nsetting per load balancer service flavor.\n", 
      "maximum": 2147483647, 
      "minimum": 2048, 
      "required": false, 
      "title": "Sets max TCP transmit buffer, specified in bytes.", 
      "type": "integer"
    }
  }, 
  "title": "TCP profile allows customization of TCP stack behavior.", 
  "type": "object"
}

LbTcpProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbTcpProfileListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbTcpProfile"+
      }, 
      "required": true, 
      "title": "Paginated list of load balancer TCP profiles", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbUdpMonitor (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LbActiveMonitor"+
  }, 
  "id": "LbUdpMonitor", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbUdpMonitor"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fall_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must fail before marking it down", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "interval": {
      "default": 5, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the frequency at which the system issues the monitor check (in second)", 
      "type": "integer"
    }, 
    "monitor_port": {
      "$ref": "PortElement"+, 
      "description": "If the monitor port is specified, it would override pool member port\nsetting for healthcheck. A port range is not supported.\n", 
      "required": false, 
      "title": "port which is used for healthcheck"
    }, 
    "receive": {
      "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", 
      "required": true, 
      "title": "expected data received from server", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "MonitorType"+, 
      "required": true
    }, 
    "rise_count": {
      "default": 3, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "num of consecutive checks must pass before marking it up", 
      "type": "integer"
    }, 
    "send": {
      "description": "The data to be sent to the monitored server.\n", 
      "required": true, 
      "title": "data to send", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "default": 15, 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the number of seconds the target has in which to respond to the monitor\nrequest\n", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LbVariableAssignmentAction (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleAction"+
  }, 
  "id": "LbVariableAssignmentAction", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbVariableAssignmentAction"
  }, 
  "properties": {
    "type": {
      "$ref": "LbRuleActionType"+, 
      "required": true, 
      "title": "Type of load balancer rule action"
    }, 
    "variable_name": {
      "required": true, 
      "title": "Name of the variable to be assigned", 
      "type": "string"
    }, 
    "variable_value": {
      "required": true, 
      "title": "Value of variable", 
      "type": "string"
    }
  }, 
  "title": "Action to create variable and assign value to it.", 
  "type": "object"
}

LbVariableCondition (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LbRuleCondition"+
  }, 
  "id": "LbVariableCondition", 
  "module_id": "LoadBalancer", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LbVariableCondition"
  }, 
  "properties": {
    "case_sensitive": {
      "default": true, 
      "description": "If true, case is significant when comparing variable value.\n", 
      "required": false, 
      "title": "A case sensitive flag for variable value comparing", 
      "type": "boolean"
    }, 
    "inverse": {
      "default": false, 
      "required": false, 
      "title": "A flag to indicate whether reverse the match result of this condition", 
      "type": "boolean"
    }, 
    "match_type": {
      "$ref": "LbRuleMatchType"+, 
      "default": "REGEX", 
      "required": false, 
      "title": "Match type of variable value"
    }, 
    "type": {
      "$ref": "LbRuleConditionType"+, 
      "required": true, 
      "title": "Type of load balancer rule condition"
    }, 
    "variable_name": {
      "required": true, 
      "title": "Name of the variable to be matched", 
      "type": "string"
    }, 
    "variable_value": {
      "required": true, 
      "title": "Value of variable to be matched", 
      "type": "string"
    }
  }, 
  "title": "Condition to match IP header fields", 
  "type": "object"
}

LbVirtualServer (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LbVirtualServer", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "access_log_enabled": {
      "default": false, 
      "details": "If access log is enabled, all HTTP requests sent to L7 virtual server\nare logged to the access log file. L4 virtual server connections are\nnot currently logged to the access log.\n", 
      "required": false, 
      "title": "Whether access log is enabled", 
      "type": "boolean"
    }, 
    "application_profile_id": {
      "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", 
      "required": true, 
      "title": "application profile identifier", 
      "type": "string"
    }, 
    "client_ssl_profile_binding": {
      "$ref": "ClientSslProfileBinding"+, 
      "description": "The setting is used when load balancer acts as an SSL server and\nterminating the client SSL connection\n", 
      "required": false, 
      "title": "Virtual server side SSL binding setting"
    }, 
    "client_tcp_profile_id": {
      "description": "Only L7 virtual server could be configured with customized client\nside TCP profile.\n", 
      "title": "Identifier of client side TCP profile", 
      "type": "string"
    }, 
    "default_pool_member_port": {
      "$ref": "PortElement"+, 
      "deprecated": true, 
      "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", 
      "required": false, 
      "title": "Default pool member port when member port is not defined."
    }, 
    "default_pool_member_ports": {
      "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", 
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 14, 
      "required": false, 
      "title": "Default pool member ports when member port is not defined.", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "whether the virtual server is enabled", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "virtual server IP address"
    }, 
    "ip_protocol": {
      "$ref": "VirtualServerIpProtocol"+, 
      "default": "TCP", 
      "description": "Assigned Internet Protocol in IP header, TCP, UDP are supported.\n", 
      "required": false, 
      "title": "virtual server IP protocol"
    }, 
    "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.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "maximum concurrent connection number", 
      "type": "integer"
    }, 
    "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.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "maximum new connection rate in second", 
      "type": "integer"
    }, 
    "persistence_profile_id": {
      "description": "Persistence profile is used to allow related client connections to be\nsent to the same backend server.\n", 
      "required": false, 
      "title": "persistence profile identifier", 
      "type": "string"
    }, 
    "pool_id": {
      "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", 
      "required": false, 
      "title": "default server pool identifier", 
      "type": "string"
    }, 
    "port": {
      "$ref": "PortElement"+, 
      "deprecated": true, 
      "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", 
      "required": false, 
      "title": "Virtual server port number or port range"
    }, 
    "ports": {
      "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", 
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 14, 
      "required": false, 
      "title": "Virtual server ports or port ranges", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "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.\n", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 512, 
      "required": false, 
      "title": "List of load balancer rule identifiers", 
      "type": "array"
    }, 
    "server_ssl_profile_binding": {
      "$ref": "ServerSslProfileBinding"+, 
      "description": "The setting is used when load balancer acts as an SSL client and\nestablishing a connection to the backend server.\n", 
      "required": false, 
      "title": "Pool side SSL binding setting"
    }, 
    "server_tcp_profile_id": {
      "description": "Only L7 virtual server could be configured with customized server\nside TCP profile.\n", 
      "title": "Identifier of server side TCP profile", 
      "type": "string"
    }, 
    "sorry_pool_id": {
      "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.\n", 
      "required": false, 
      "title": "Identifier of sorry server pool", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LbVirtualServerListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LbVirtualServerListRequestParameters", 
  "module_id": "UILb", 
  "properties": {
    "application_profile_id": {
      "description": "Specify application profile id to filter corresponding virtual server.\nReturn virtual servers which are associdated with this application\nprofile.\n", 
      "title": "Application profile id specified to filter corresponding virtual\nservers\n", 
      "type": "string"
    }, 
    "client_ssl_profile_id": {
      "description": "Specify client ssl profile id to filter corresponding virtual server.\nReturn virtual servers which are associdated with this client ssl\nprofile.\n", 
      "title": "Client ssl profile id specified to filter corresponding virtual\nservers\n", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "persistence_profile_id": {
      "description": "Specify persistence profile id to filter corresponding virtual server.\nReturn virtual servers which are associdated with this persistence\nprofile.\n", 
      "title": "Persistence profile id specified to filter corresponding virtual\nservers\n", 
      "type": "string"
    }, 
    "pool_id": {
      "description": "Specify pool id to filter corresponding virtual server. Return virtual\nservers which are associdated with this pool.\n", 
      "title": "Pool id specified to filter corresponding virtual servers", 
      "type": "string"
    }, 
    "server_ssl_profile_id": {
      "description": "Specify server ssl profile id to filter corresponding virtual server.\nReturn virtual servers which are associdated with this server ssl\nprofile.\n", 
      "title": "Server ssl profile id specified to filter corresponding virtual\nservers\n", 
      "type": "string"
    }, 
    "service_id": {
      "description": "Specify lb service id to filter corresponding virtual server. Return\nvirtual servers which are associdated with this lbs.\n", 
      "title": "Lbs id specified to filter corresponding virtual servers", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbVirtualServerListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbVirtualServerListResult", 
  "module_id": "LoadBalancer", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbVirtualServer"+
      }, 
      "required": true, 
      "title": "paginated list of virtual servers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbVirtualServerStatistics (type) 

{
  "id": "LbVirtualServerStatistics", 
  "module_id": "AggSvcLb", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "title": "Timestamp when the data was last updated"
    }, 
    "statistics": {
      "$ref": "LbStatisticsCounter"+, 
      "required": true, 
      "title": "Virtual server statistics counter"
    }, 
    "virtual_server_id": {
      "required": true, 
      "title": "load balancer virtual server identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbVirtualServerStatisticsListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbVirtualServerStatisticsListResult", 
  "module_id": "AggSvcLb", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbVirtualServerStatistics"+
      }, 
      "required": true, 
      "title": "paginated statistics list of virtual servers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbVirtualServerStatus (type) 

{
  "id": "LbVirtualServerStatus", 
  "module_id": "AggSvcLb", 
  "properties": {
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "title": "Timestamp when the data was last updated."
    }, 
    "status": {
      "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.\nUNKOWN means that no status reported from transport-nodes. The\nassociated load balancer service may be working(or not working).\n", 
      "enum": [
        "UP", 
        "PARTIALLY_UP", 
        "PRIMARY_DOWN", 
        "DOWN", 
        "DETACHED", 
        "DISABLED", 
        "UNKNOWN"
      ], 
      "title": "Virtual server status", 
      "type": "string"
    }, 
    "virtual_server_id": {
      "required": true, 
      "title": "load balancer virtual server identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LbVirtualServerStatusListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LbVirtualServerStatusListResult", 
  "module_id": "AggSvcLb", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LbVirtualServerStatus"+
      }, 
      "required": true, 
      "title": "paginated status list of virtual servers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

License (type) 

{
  "additionalProperties": false, 
  "description": "license properties", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "License", 
  "module_id": "License", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "capacity_type": {
      "enum": [
        "VM", 
        "CPU", 
        "USER"
      ], 
      "readonly": true, 
      "title": "license metric", 
      "type": "string"
    }, 
    "description": {
      "readonly": true, 
      "title": "license edition", 
      "type": "string"
    }, 
    "expiry": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "date that license expires"
    }, 
    "features": {
      "readonly": true, 
      "title": "semicolon delimited feature list", 
      "type": "string"
    }, 
    "is_eval": {
      "readonly": true, 
      "title": "true for evalution license", 
      "type": "boolean"
    }, 
    "is_expired": {
      "readonly": true, 
      "title": "whether the license has expired", 
      "type": "boolean"
    }, 
    "is_mh": {
      "readonly": true, 
      "title": "multi-hypervisor support", 
      "type": "boolean"
    }, 
    "license_key": {
      "pattern": "^[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}$", 
      "required": true, 
      "sensitive": true, 
      "title": "license key", 
      "type": "string", 
      "validation_msg_key": "com.vmware.nsx.validation.constraints.License.license_key.message"
    }, 
    "product_name": {
      "readonly": true, 
      "title": "product name", 
      "type": "string"
    }, 
    "product_version": {
      "readonly": true, 
      "title": "product version", 
      "type": "string"
    }, 
    "quantity": {
      "readonly": true, 
      "title": "license capacity; 0 for unlimited", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

LicensesListResult (type) 

{
  "description": "Licenses queries result", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LicensesListResult", 
  "module_id": "License", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "License"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Licenses Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListByNodeIdParameters (type) 

{
  "extends": {
    "$ref": "ListWithDataSourceParameters"+
  }, 
  "id": "ListByNodeIdParameters", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListByOptionalNodeIdParameters (type) 

{
  "extends": {
    "$ref": "ListWithDataSourceParameters"+
  }, 
  "id": "ListByOptionalNodeIdParameters", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "Transport node id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListByRequiredNodeIdParameters (type) 

{
  "extends": {
    "$ref": "ListWithDataSourceParameters"+
  }, 
  "id": "ListByRequiredNodeIdParameters", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": true, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListCertParameter (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ListCertParameter", 
  "module_id": "CertificateManager", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "details": {
      "default": false, 
      "required": false, 
      "title": "whether to expand the pem data and show all its details", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "description": "Provide this parameter to limit the list of returned certificates to those matching a particular usage.\nPassing cluster_certificate will return the certificate used for the cluster wide API service.\n", 
      "enum": [
        "cluster_api_certificate"
      ], 
      "required": false, 
      "title": "Type of certificate to return", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListRequestParameters (type) 

{
  "additionalProperties": {}, 
  "extends": {
    "$ref": "IncludedFieldsParameters"+
  }, 
  "id": "ListRequestParameters", 
  "module_id": "Common", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListResult (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "ListResult", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Base class for list results from collections", 
  "type": "object"
}

ListResultQueryParameters (type) 

{
  "id": "ListResultQueryParameters", 
  "module_id": "Common", 
  "properties": {
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }
  }, 
  "title": "Parameters that affect how list results are processed", 
  "type": "object"
}

ListWithDataSourceParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ListWithDataSourceParameters", 
  "module_id": "Types", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

LldpHostSwitchProfile (type) 

{
  "extends": {
    "$ref": "BaseHostSwitchProfile"+
  }, 
  "id": "LldpHostSwitchProfile", 
  "module_id": "LldpHostSwitchProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LldpHostSwitchProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "HostSwitchProfileType"+, 
      "required": true
    }, 
    "send_enabled": {
      "required": true, 
      "title": "Enabled or disabled sending LLDP packets", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Host Switch for LLDP", 
  "type": "object"
}

LoadBalancerAllocationPool (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "EdgeClusterMemberAllocationPool"+
  }, 
  "id": "LoadBalancerAllocationPool", 
  "module_id": "LogicalRouter", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LoadBalancerAllocationPool"
  }, 
  "properties": {
    "allocation_pool_type": {
      "$ref": "AllocationPoolType"+, 
      "required": true
    }, 
    "allocation_size": {
      "default": "SMALL", 
      "description": "To address varied customer performance and scalability requirements,\ndifferent sizes for load balancer service are supported: SMALL, MEDIUM\nand LARGE, each with its own set of resource and performance. Specify\nsize of load balancer service which you will bind to TIER1 router.\n", 
      "enum": [
        "SMALL", 
        "MEDIUM", 
        "LARGE"
      ], 
      "required": true, 
      "title": "Size of load balancer service", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalDhcpServer (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LogicalDhcpServer", 
  "module_id": "Dhcp", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attached_logical_port_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of attached logical port", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_profile_id": {
      "required": true, 
      "title": "dhcp profile uuid", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipv4_dhcp_server": {
      "$ref": "IPv4DhcpServer"+, 
      "required": true, 
      "title": "dhcp server for ipv4 addresses"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalDhcpServerListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalDhcpServerListResult", 
  "module_id": "Dhcp", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalDhcpServer"+
      }, 
      "required": true, 
      "title": "paginated list of dhcp servers", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalPort (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LogicalPort", 
  "module_id": "LogicalPort", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "address_bindings": {
      "help_detail": "Each address binding must contain an IPElement and/or 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. A maximum of 128 unique\naddress bindings is allowed per port.\n", 
      "help_summary": "Addresses that are statically bound to the logical port", 
      "items": {
        "$ref": "PacketAddressClassifier"+
      }, 
      "maxItems": 512, 
      "minItems": 0, 
      "required": false, 
      "title": "Address bindings for logical port", 
      "type": "array"
    }, 
    "admin_state": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "required": true, 
      "title": "Represents Desired state of the logical port", 
      "type": "string"
    }, 
    "attachment": {
      "$ref": "LogicalPortAttachment"+, 
      "required": false, 
      "title": "Logical port attachment"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "extra_configs": {
      "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", 
      "items": {
        "$ref": "ExtraConfig"+
      }, 
      "required": false, 
      "title": "Extra configs on logical port", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "init_state": {
      "$ref": "LogicalPortInitState"+, 
      "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.\n", 
      "required": false, 
      "title": "Initial state of this logical ports"
    }, 
    "logical_switch_id": {
      "required": true, 
      "title": "Id of the Logical switch that this port belongs to.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "switching_profile_ids": {
      "items": {
        "$ref": "SwitchingProfileTypeIdEntry"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalPortAttachment (type) 

{
  "id": "LogicalPortAttachment", 
  "module_id": "LogicalPort", 
  "properties": {
    "attachment_type": {
      "$ref": "AttachmentType"+, 
      "default": "VIF", 
      "description": "Indicates the type of logical port attachment. By default it is Virtual Machine interface (VIF)", 
      "required": false, 
      "title": "Type of attachment for logical port"
    }, 
    "context": {
      "$ref": "AttachmentContext"+, 
      "description": "Extra context data for the attachment", 
      "required": false, 
      "title": "Attachment context"
    }, 
    "id": {
      "required": true, 
      "title": "Identifier of the interface attached to the logical port", 
      "type": "string"
    }
  }, 
  "title": "Logical port attachment", 
  "type": "object"
}

LogicalPortInitState (type) 

{
  "enum": [
    "UNBLOCKED_VLAN"
  ], 
  "id": "LogicalPortInitState", 
  "module_id": "LogicalPort", 
  "title": "Supported initial state of logical port", 
  "type": "string"
}

LogicalPortListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LogicalPortListParameters", 
  "module_id": "LogicalPort", 
  "properties": {
    "attachment_id": {
      "required": false, 
      "title": "Logical Port attachment Id", 
      "type": "string"
    }, 
    "attachment_type": {
      "$ref": "AttachmentTypeQueryString"+, 
      "required": false, 
      "title": "Type of attachment for logical port; NONE means no attachment."
    }, 
    "bridge_cluster_id": {
      "required": false, 
      "title": "Bridge Cluster identifier", 
      "type": "string"
    }, 
    "container_ports_only": {
      "default": false, 
      "required": false, 
      "title": "Only container VIF logical ports will be returned if true", 
      "type": "boolean"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "diagnostic": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable showing of transit logical port.", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "required": false, 
      "title": "Logical Switch identifier", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "parent_vif_id": {
      "description": "Get logical ports that have CHILD VIF attachment of given\nPARENT VIF.\n", 
      "required": false, 
      "title": "ID of the VIF of type PARENT", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "switching_profile_id": {
      "required": false, 
      "title": "Network Profile identifier", 
      "type": "string"
    }, 
    "transport_node_id": {
      "description": "Get logical ports on the transport node; it can not be given\ntogether with other parameters except container_ports_only and\nattachment_type VIF.\n", 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }, 
    "transport_zone_id": {
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }
  }, 
  "title": "Logical port list parameters", 
  "type": "object"
}

LogicalPortListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalPortListResult", 
  "module_id": "LogicalPort", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalPort"+
      }, 
      "readonly": true, 
      "title": "LogicalPort Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Logical port queries result", 
  "type": "object"
}

LogicalPortListWithSourceParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LogicalPortListParameters"+
  }, 
  "id": "LogicalPortListWithSourceParameters", 
  "module_id": "AggSvcLogicalPort", 
  "properties": {
    "attachment_id": {
      "required": false, 
      "title": "Logical Port attachment Id", 
      "type": "string"
    }, 
    "attachment_type": {
      "$ref": "AttachmentTypeQueryString"+, 
      "required": false, 
      "title": "Type of attachment for logical port; NONE means no attachment."
    }, 
    "bridge_cluster_id": {
      "required": false, 
      "title": "Bridge Cluster identifier", 
      "type": "string"
    }, 
    "container_ports_only": {
      "default": false, 
      "required": false, 
      "title": "Only container VIF logical ports will be returned if true", 
      "type": "boolean"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "diagnostic": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable showing of transit logical port.", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "required": false, 
      "title": "Logical Switch identifier", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "parent_vif_id": {
      "description": "Get logical ports that have CHILD VIF attachment of given\nPARENT VIF.\n", 
      "required": false, 
      "title": "ID of the VIF of type PARENT", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "switching_profile_id": {
      "required": false, 
      "title": "Network Profile identifier", 
      "type": "string"
    }, 
    "transport_node_id": {
      "description": "Get logical ports on the transport node; it can not be given\ntogether with other parameters except container_ports_only and\nattachment_type VIF.\n", 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }, 
    "transport_zone_id": {
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }
  }, 
  "title": "Logical Port list with data source parameters", 
  "type": "object"
}

LogicalPortMacAddressCsvListResult (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "LogicalPortMacAddressCsvListResult", 
  "module_id": "AggSvcLogicalPort", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "LogicalPortMacTableCsvEntry"+
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalPortMacAddressListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalPortMacAddressListResult", 
  "module_id": "AggSvcLogicalPort", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_port_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the logical port", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalPortMacTableEntry"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalPortMacTableCsvEntry (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "LogicalPortMacTableCsvEntry", 
  "module_id": "AggSvcLogicalPort", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "mac_type": {
      "$ref": "MacAddressType"+, 
      "required": true, 
      "title": "The type of the MAC address"
    }
  }, 
  "type": "object"
}

LogicalPortMacTableEntry (type) 

{
  "id": "LogicalPortMacTableEntry", 
  "module_id": "AggSvcLogicalPort", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "mac_type": {
      "$ref": "MacAddressType"+, 
      "required": true, 
      "title": "The type of the MAC address"
    }
  }, 
  "type": "object"
}

LogicalPortMirrorDestination (type) 

{
  "extends": {
    "$ref": "MirrorDestination"+
  }, 
  "id": "LogicalPortMirrorDestination", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalPortMirrorDestination"
  }, 
  "properties": {
    "port_ids": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 3, 
      "minItems": 1, 
      "required": true, 
      "title": "Destination logical port identifier list.", 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "MirrorDestinationResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorDestination'", 
      "required": true
    }
  }, 
  "type": "object"
}

LogicalPortMirrorSource (type) 

{
  "extends": {
    "$ref": "MirrorSource"+
  }, 
  "id": "LogicalPortMirrorSource", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalPortMirrorSource"
  }, 
  "properties": {
    "port_ids": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Source logical port identifier list", 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "MirrorSourceResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorSource', 'PnicMirrorSource'", 
      "required": true
    }
  }, 
  "type": "object"
}

LogicalRouter (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LogicalRouter", 
  "module_id": "LogicalRouter", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "advanced_config": {
      "$ref": "LogicalRouterConfig"+, 
      "description": "Contains config properties for tier0 routers", 
      "required": false, 
      "title": "Logical Router Configuration"
    }, 
    "allocation_profile": {
      "$ref": "EdgeClusterMemberAllocationProfile"+, 
      "description": "Configurations options to auto allocate edge cluster members for\nlogical router. Auto allocation is supported only for TIER1 and pick\nleast utilized member post current assignment for next allocation.\n", 
      "required": false, 
      "title": "Edge Cluster Member Allocation Profile"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_id": {
      "description": "Used for tier0 routers", 
      "required": false, 
      "title": "Identifier of the edge cluster for this Logical Router", 
      "type": "string"
    }, 
    "edge_cluster_member_indices": {
      "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", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Member indices of the edge node on the cluster", 
      "type": "array"
    }, 
    "failover_mode": {
      "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", 
      "enum": [
        "PREEMPTIVE", 
        "NON_PREEMPTIVE"
      ], 
      "required": false, 
      "title": "Failover mode for active-standby logical router instances.", 
      "type": "string"
    }, 
    "firewall_sections": {
      "description": "List of Firewall sections related to Logical Router.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "LR Firewall Section References", 
      "type": "array"
    }, 
    "high_availability_mode": {
      "enum": [
        "ACTIVE_ACTIVE", 
        "ACTIVE_STANDBY"
      ], 
      "required": false, 
      "title": "High availability mode", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "preferred_edge_cluster_member_index": {
      "description": "Used for tier0 routers only", 
      "minimum": 0, 
      "required": false, 
      "title": "Preferred edge cluster member index in active standby mode\nfor pre-emptive failover\n", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "router_type": {
      "enum": [
        "TIER0", 
        "TIER1"
      ], 
      "required": true, 
      "title": "Type of Logical Router", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalRouterCentralizedServicePort (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LogicalRouterPort"+
  }, 
  "id": "LogicalRouterCentralizedServicePort", 
  "module_id": "LogicalRouterPorts", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalRouterCentralizedServicePort"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enable_netx": {
      "default": false, 
      "required": false, 
      "title": "Port is exclusively used for N-S service insertion", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "linked_logical_switch_port_id": {
      "$ref": "ResourceReference"+, 
      "required": false, 
      "title": "Reference to the logical switch port to connect to"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "subnets": {
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Logical router port subnets", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "urpf_mode": {
      "$ref": "UrpfMode"+, 
      "default": "STRICT", 
      "required": false, 
      "title": "Unicast Reverse Path Forwarding mode"
    }
  }, 
  "title": "Port to connect VLAN based network or overlay logical switch", 
  "type": "object"
}

LogicalRouterConfig (type) 

{
  "additionalProperties": false, 
  "id": "LogicalRouterConfig", 
  "module_id": "LogicalRouter", 
  "properties": {
    "external_transit_networks": {
      "items": {
        "$ref": "IPv4CIDRBlock"+
      }, 
      "required": false, 
      "title": "CIDR block defining tier0 to tier1 links", 
      "type": "array"
    }, 
    "ha_vip_configs": {
      "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.", 
      "items": {
        "$ref": "HaVipConfig"+
      }, 
      "required": false, 
      "title": "Array of HA VIP Config.", 
      "type": "array"
    }, 
    "internal_transit_network": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": false, 
      "title": "CIDR block defining Service router to distributed router links"
    }, 
    "transport_zone_id": {
      "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.", 
      "required": false, 
      "title": "Transport Zone Identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterDownLinkPort (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LogicalRouterPort"+
  }, 
  "id": "LogicalRouterDownLinkPort", 
  "module_id": "LogicalRouterPorts", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalRouterDownLinkPort"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "linked_logical_switch_port_id": {
      "$ref": "ResourceReference"+, 
      "required": false, 
      "title": "Reference to the logical switch port to connect to"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "mac_address": {
      "description": "MAC address", 
      "readonly": true, 
      "required": false, 
      "title": "MAC address", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "subnets": {
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Logical router port subnets", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "urpf_mode": {
      "$ref": "UrpfMode"+, 
      "default": "STRICT", 
      "required": false, 
      "title": "Unicast Reverse Path Forwarding mode"
    }
  }, 
  "type": "object"
}

LogicalRouterFIBListRequestParameters (type) 

{
  "extends": {
    "$ref": "ListByRequiredNodeIdParameters"+
  }, 
  "id": "LogicalRouterFIBListRequestParameters", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "network_prefix": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": false, 
      "title": "CIDR network address to filter the RIB and FIB table."
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": true, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterFIBRequestParameters (type) 

{
  "extends": {
    "$ref": "RequiredTransportNodeIdParameters"+
  }, 
  "id": "LogicalRouterFIBRequestParameters", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "network_prefix": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": false, 
      "title": "CIDR network address to filter the the RIB and FIB table."
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": true, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterIPTunnelPort (type) 

{
  "additionalProperties": false, 
  "description": "Logical router IP tunnel port.", 
  "extends": {
    "$ref": "LogicalRouterPort"+
  }, 
  "id": "LogicalRouterIPTunnelPort", 
  "module_id": "LogicalRouterPorts", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "admin_state": {
      "description": "Admin state of port.", 
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "readonly": true, 
      "title": "Admin state of port", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "subnets": {
      "description": "Tunnel port subnets.", 
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "readonly": true, 
      "required": true, 
      "title": "Tunnel port subnets", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vpn_session_id": {
      "description": "Associated VPN session identifier.", 
      "readonly": true, 
      "title": "VPN session identifier", 
      "type": "string"
    }
  }, 
  "title": "Logical router IP tunnel port", 
  "type": "object"
}

LogicalRouterLinkPortOnTIER0 (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LogicalRouterPort"+
  }, 
  "id": "LogicalRouterLinkPortOnTIER0", 
  "module_id": "LogicalRouterPorts", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalRouterLinkPortOnTIER0"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "linked_logical_router_port_id": {
      "description": "Identifier of connected LogicalRouterLinkPortOnTIER1 of TIER1 logical router", 
      "readonly": true, 
      "required": false, 
      "title": "Identifier of connected LogicalRouterLinkPortOnTIER1", 
      "type": "string"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "mac_address": {
      "description": "MAC address", 
      "readonly": true, 
      "required": false, 
      "title": "MAC address", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "subnets": {
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Logical router port subnets", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Port to connect the LogicalRouterLinkPortOnTIER1 of TIER1 logical router to", 
  "type": "object"
}

LogicalRouterLinkPortOnTIER1 (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "LogicalRouterPort"+
  }, 
  "id": "LogicalRouterLinkPortOnTIER1", 
  "module_id": "LogicalRouterPorts", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalRouterLinkPortOnTIER1"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_member_index": {
      "deprecated": true, 
      "description": "Please use logical router API to pass edge cluster members indexes manually.\n", 
      "items": {
        "type": "integer"
      }, 
      "required": false, 
      "title": "Member index of the edge node on the cluster", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "linked_logical_router_port_id": {
      "$ref": "ResourceReference"+, 
      "description": "Reference of LogicalRouterLinkPortOnTIER0 of TIER0 logical router to connect this TIER1 logical router outwards.\n", 
      "required": false, 
      "title": "Reference of TIER0 port to connect the TIER1 to."
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "mac_address": {
      "description": "MAC address", 
      "readonly": true, 
      "required": false, 
      "title": "MAC address", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "subnets": {
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Logical router port subnets", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Port to connect the TIER1 logical router to TIER0 logical router", 
  "type": "object"
}

LogicalRouterListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LogicalRouterListParameters", 
  "module_id": "LogicalRouter", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "router_type": {
      "enum": [
        "TIER0", 
        "TIER1"
      ], 
      "required": false, 
      "title": "Type of Logical Router", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Logical Router list parameters", 
  "type": "object"
}

LogicalRouterListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalRouterListResult", 
  "module_id": "LogicalRouter", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalRouter"+
      }, 
      "required": true, 
      "title": "Logical router list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterLoopbackPort (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LogicalRouterPort"+
  }, 
  "id": "LogicalRouterLoopbackPort", 
  "module_id": "LogicalRouterPorts", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalRouterLoopbackPort"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_member_index": {
      "items": {
        "type": "integer"
      }, 
      "required": true, 
      "title": "Member index of the edge node on the cluster", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "subnets": {
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Loopback port subnets", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalRouterPort (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LogicalRouterPort", 
  "module_id": "LogicalRouterPorts", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalRouterPortArpCsvRecord (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "LogicalRouterPortArpCsvRecord", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "ip": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "The IP address"
    }, 
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterPortArpEntry (type) 

{
  "id": "LogicalRouterPortArpEntry", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "ip": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "The IP address"
    }, 
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterPortArpTable (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalRouterPortArpTable", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "logical_router_port_id": {
      "required": true, 
      "title": "The ID of the logical router port", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalRouterPortArpEntry"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterPortArpTableInCsvFormat (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "LogicalRouterPortArpTableInCsvFormat", 
  "module_id": "AggSvcLogicalRouterPort", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "Timestamp when the data was last updated; unset if data source has never updated the data."
    }, 
    "results": {
      "items": {
        "$ref": "LogicalRouterPortArpCsvRecord"+
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalRouterPortListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalRouterPortListResult", 
  "module_id": "LogicalRouterPorts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalRouterPort"+
      }, 
      "required": true, 
      "title": "Logical router port list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterPortResourceType (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "LogicalRouterPortResourceType", 
  "module_id": "LogicalRouterPorts", 
  "title": "Resource types of logical router port", 
  "type": "string"
}

LogicalRouterPortsListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LogicalRouterPortsListParameters", 
  "module_id": "LogicalRouterPorts", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "logical_router_id": {
      "required": false, 
      "title": "Logical Router identifier", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "required": false, 
      "title": "Logical Switch identifier", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": false, 
      "title": "Resource Type"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Logical Router Ports list parameters", 
  "type": "object"
}

LogicalRouterRIBListRequestParameters (type) 

{
  "extends": {
    "$ref": "ListByRequiredNodeIdParameters"+
  }, 
  "id": "LogicalRouterRIBListRequestParameters", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "network_prefix": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": false, 
      "title": "CIDR network address to filter the RIB and FIB table."
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "route_source": {
      "enum": [
        "BGP", 
        "STATIC", 
        "CONNECTED"
      ], 
      "required": false, 
      "title": "To filter the RIB table based on the source from which route is learned.", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": true, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterRIBRequestParameters (type) 

{
  "extends": {
    "$ref": "RequiredTransportNodeIdParameters"+
  }, 
  "id": "LogicalRouterRIBRequestParameters", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "network_prefix": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": false, 
      "title": "CIDR network address to filter the the RIB and FIB table."
    }, 
    "route_source": {
      "enum": [
        "BGP", 
        "STATIC", 
        "CONNECTED"
      ], 
      "required": false, 
      "title": "To filter the RIB table based on the source from which route is learned.", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": true, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterRouteCsvRecord (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "LogicalRouterRouteCsvRecord", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "admin_distance": {
      "required": false, 
      "title": "The admin distance of the next hop", 
      "type": "integer"
    }, 
    "logical_router_port_id": {
      "required": false, 
      "title": "The id of the logical router port which is used as the next hop", 
      "type": "string"
    }, 
    "lr_component_id": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) id", 
      "type": "string"
    }, 
    "lr_component_type": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) type", 
      "type": "string"
    }, 
    "network": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": true, 
      "title": "CIDR network address"
    }, 
    "next_hop": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "The IP of the next hop"
    }, 
    "route_type": {
      "required": true, 
      "title": "Route type (USER, CONNECTED, NSX_INTERNAL,..)", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterRouteEntry (type) 

{
  "id": "LogicalRouterRouteEntry", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "admin_distance": {
      "required": false, 
      "title": "The admin distance of the next hop", 
      "type": "integer"
    }, 
    "logical_router_port_id": {
      "required": false, 
      "title": "The id of the logical router port which is used as the next hop", 
      "type": "string"
    }, 
    "lr_component_id": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) id", 
      "type": "string"
    }, 
    "lr_component_type": {
      "required": false, 
      "title": "Logical router component(Service Router/Distributed Router) type", 
      "type": "string"
    }, 
    "network": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": true, 
      "title": "CIDR network address"
    }, 
    "next_hop": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "The IP address of the next hop"
    }, 
    "route_type": {
      "required": true, 
      "title": "Route type (USER, CONNECTED, NSX_INTERNAL,..)", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterRouteTable (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalRouterRouteTable", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "The id of the logical router", 
      "type": "string"
    }, 
    "logical_router_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the logical router", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalRouterRouteEntry"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalRouterRouteTableInCsvFormat (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "LogicalRouterRouteTableInCsvFormat", 
  "module_id": "AggSvcLogicalRouter", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "LogicalRouterRouteCsvRecord"+
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalRouterUpLinkPort (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LogicalRouterPort"+
  }, 
  "id": "LogicalRouterUpLinkPort", 
  "module_id": "LogicalRouterPorts", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalRouterUpLinkPort"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_member_index": {
      "items": {
        "type": "integer"
      }, 
      "required": true, 
      "title": "Member index of the edge node on the cluster", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "linked_logical_switch_port_id": {
      "$ref": "ResourceReference"+, 
      "required": false, 
      "title": "Reference to the logical switch port to connect to"
    }, 
    "logical_router_id": {
      "required": true, 
      "title": "Identifier for logical router on which this port is created", 
      "type": "string"
    }, 
    "mac_address": {
      "description": "MAC address", 
      "readonly": true, 
      "required": false, 
      "title": "MAC address", 
      "type": "string"
    }, 
    "mtu": {
      "default": 1500, 
      "description": "Maximum transmission unit specifies the size of the largest packet that a network protocol can transmit.", 
      "maximum": 9000, 
      "minimum": 64, 
      "title": "Maximum transmission unit (MTU)", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "LogicalRouterPortResourceType"+, 
      "required": true
    }, 
    "service_bindings": {
      "items": {
        "$ref": "ServiceBinding"+
      }, 
      "required": false, 
      "title": "Service Bindings", 
      "type": "array"
    }, 
    "subnets": {
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Logical router port subnets", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "urpf_mode": {
      "$ref": "UrpfMode"+, 
      "default": "STRICT", 
      "required": false, 
      "title": "Unicast Reverse Path Forwarding mode"
    }
  }, 
  "type": "object"
}

LogicalService (type) (Deprecated) 

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LogicalService", 
  "module_id": "LogicalService", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_relay_profile_id": {
      "required": true, 
      "title": "dhcp relay profile referenced by the dhcp relay service", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "LogicalServiceResourceTypes"+, 
      "help_summary": "Possible value is 'DhcpRelayService'", 
      "required": true, 
      "title": "Resource type of the logical service"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

LogicalServiceListResult (type) (Deprecated) 

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalServiceListResult", 
  "module_id": "LogicalService", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalService"+
      }, 
      "required": true, 
      "title": "Logical router service list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalServiceResourceTypes (type) (Deprecated) 

{
  "additionalProperties": false, 
  "deprecated": true, 
  "enum": [
    "DhcpRelayService"
  ], 
  "id": "LogicalServiceResourceTypes", 
  "module_id": "LogicalService", 
  "title": "Resource types of logical services", 
  "type": "string"
}

LogicalSwitch (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "LogicalSwitch", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "address_bindings": {
      "help_detail": "Each address binding must contain an IPElement and/or MAC address.\nVLAN ID is optional. This binding configuration can be used by\nfeatures such as spoof-guard.\n", 
      "help_summary": "Allowed addresses or range of addresses for the Logical Switch.", 
      "items": {
        "$ref": "PacketAddressClassifier"+
      }, 
      "maxItems": 100, 
      "minItems": 0, 
      "required": false, 
      "title": "Address bindings for the Logical switch", 
      "type": "array"
    }, 
    "admin_state": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "required": true, 
      "title": "Represents Desired state of the Logical Switch", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "extra_configs": {
      "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", 
      "items": {
        "$ref": "ExtraConfig"+
      }, 
      "required": false, 
      "title": "Extra configs on logical switch", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_pool_id": {
      "description": "IP pool id that associated with a LogicalSwitch.", 
      "required": false, 
      "title": "Allocation ip pool associated with the Logical switch", 
      "type": "string"
    }, 
    "mac_pool_id": {
      "description": "Mac pool id that associated with a LogicalSwitch.", 
      "required": false, 
      "title": "Allocation mac pool associated with the Logical switch", 
      "type": "string"
    }, 
    "replication_mode": {
      "enum": [
        "MTEP", 
        "SOURCE"
      ], 
      "required": false, 
      "title": "Replication mode of the Logical Switch", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "switching_profile_ids": {
      "items": {
        "$ref": "SwitchingProfileTypeIdEntry"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zone_id": {
      "required": true, 
      "title": "Id of the TransportZone to which this LogicalSwitch is associated", 
      "type": "string"
    }, 
    "uplink_teaming_policy_name": {
      "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.", 
      "required": false, 
      "title": "The name of the switching uplink teaming policy for the logical switch", 
      "type": "string"
    }, 
    "vlan": {
      "$ref": "VlanID"+, 
      "description": "This property is dedicated to VLAN based network, to set VLAN of logical\nnetwork. It is mutually exclusive with 'vlan_trunk_spec'.\n", 
      "required": false, 
      "title": "VLAN Id of logical switch"
    }, 
    "vlan_trunk_spec": {
      "$ref": "VlanTrunkSpec"+, 
      "description": "This property is used for VLAN trunk specification of logical switch.\nIt's mutually exclusive with 'vlan'. Also it could be set to do guest VLAN\ntagging in overlay network.\n", 
      "required": false, 
      "title": "VLAN trunk spec of logical switch"
    }, 
    "vni": {
      "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", 
      "required": false, 
      "title": "VNI for this LogicalSwitch.", 
      "type": "int"
    }
  }, 
  "type": "object"
}

LogicalSwitchInfo (type) 

{
  "additionalProperties": false, 
  "id": "LogicalSwitchInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "instances_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of instances on this logical switch", 
      "type": "integer"
    }, 
    "is_default_logical_switch": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is the default logical switch", 
      "type": "boolean"
    }, 
    "logical_switch_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the logical switch", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the logical switch", 
      "type": "string"
    }, 
    "nsx_switch_tag": {
      "readonly": true, 
      "required": false, 
      "title": "This tag is applied on cloud compute resource to be attached to this\nlogical switch\n", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalSwitchListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "LogicalSwitchListParameters", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "diagnostic": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable showing of transit logical switch.", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "switching_profile_id": {
      "required": false, 
      "title": "Switching Profile identifier", 
      "type": "string"
    }, 
    "transport_type": {
      "$ref": "TransportType"+, 
      "required": false, 
      "title": "Mode of transport supported in the transport zone for this logical switch"
    }, 
    "transport_zone_id": {
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }, 
    "uplink_teaming_policy_name": {
      "required": false, 
      "title": "The logical switch's uplink teaming policy name", 
      "type": "string"
    }, 
    "vlan": {
      "$ref": "VlanID"+, 
      "required": false, 
      "title": "Return VLAN logical switches whose \"vlan\" field matches this value"
    }, 
    "vni": {
      "required": false, 
      "title": "VNI of the OVERLAY LogicalSwitch(es) to return.", 
      "type": "int"
    }
  }, 
  "title": "Logical Switch list parameters", 
  "type": "object"
}

LogicalSwitchListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalSwitchListResult", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalSwitch"+
      }, 
      "readonly": true, 
      "title": "Logical Switch Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Logical Switch queries result", 
  "type": "object"
}

LogicalSwitchListWithSourceParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LogicalSwitchListParameters"+
  }, 
  "id": "LogicalSwitchListWithSourceParameters", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "diagnostic": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable showing of transit logical switch.", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "switching_profile_id": {
      "required": false, 
      "title": "Switching Profile identifier", 
      "type": "string"
    }, 
    "transport_type": {
      "$ref": "TransportType"+, 
      "required": false, 
      "title": "Mode of transport supported in the transport zone for this logical switch"
    }, 
    "transport_zone_id": {
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }, 
    "uplink_teaming_policy_name": {
      "required": false, 
      "title": "The logical switch's uplink teaming policy name", 
      "type": "string"
    }, 
    "vlan": {
      "$ref": "VlanID"+, 
      "required": false, 
      "title": "Return VLAN logical switches whose \"vlan\" field matches this value"
    }, 
    "vni": {
      "required": false, 
      "title": "VNI of the OVERLAY LogicalSwitch(es) to return.", 
      "type": "int"
    }
  }, 
  "title": "Logical Switch list with data source parameters", 
  "type": "object"
}

LogicalSwitchMirrorSource (type) 

{
  "extends": {
    "$ref": "MirrorSource"+
  }, 
  "id": "LogicalSwitchMirrorSource", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "LogicalSwitchMirrorSource"
  }, 
  "properties": {
    "resource_type": {
      "$ref": "MirrorSourceResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorSource', 'PnicMirrorSource'", 
      "required": true
    }, 
    "switch_id": {
      "required": true, 
      "title": "Source logical switch identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalSwitchState (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ConfigurationState"+
  }, 
  "id": "LogicalSwitchState", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the logical switch", 
      "type": "string"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

LogicalSwitchStateListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalSwitchStateListResult", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalSwitchState"+
      }, 
      "readonly": true, 
      "title": "Logical Switch State Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Logical Switch state queries result", 
  "type": "object"
}

LogicalSwitchStatus (type) 

{
  "additionalProperties": false, 
  "id": "LogicalSwitchStatus", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Unique ID identifying the the Logical Switch", 
      "type": "string"
    }, 
    "num_logical_ports": {
      "readonly": true, 
      "required": false, 
      "title": "Count of Logical Ports belonging to this switch", 
      "type": "int"
    }
  }, 
  "type": "object"
}

LogicalSwitchStatusListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "LogicalSwitchStatusListResult", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "LogicalSwitchStatus"+
      }, 
      "readonly": true, 
      "title": "LogicalSwitchStatus Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Logical Switch runtime status queries result", 
  "type": "object"
}

LoginCredential (type) 

{
  "id": "LoginCredential", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "credential_type"
  }, 
  "properties": {
    "credential_type": {
      "description": "Possible values are 'UsernamePasswordLoginCredential', 'VerifiableAsymmetricLoginCredential'.", 
      "required": true, 
      "title": "Login credential, for example username-password-thumbprint or certificate based, etc", 
      "type": "string"
    }
  }, 
  "title": "Base type for various login credential types", 
  "type": "object"
}

MACAddress (type) 

{
  "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", 
  "id": "MACAddress", 
  "module_id": "Common", 
  "pattern": "^(([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2}))|(([0-9A-Fa-f]{2}[-]){5}([0-9A-Fa-f]{2}))$", 
  "title": "MAC Address", 
  "type": "string"
}

MACAddressElement (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "MACAddressElement", 
  "module_id": "MACSet", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "mac_address": {
      "$ref": "MACAddress"+, 
      "required": true
    }
  }, 
  "title": "MAC Address", 
  "type": "object"
}

MACAddressElementListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "MACAddressElementListResult", 
  "module_id": "MACSet", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MACAddressElement"+
      }, 
      "required": true, 
      "title": "MAC address element list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Collection of MAC address elements", 
  "type": "object"
}

MACSet (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "MACSet", 
  "module_id": "MACSet", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mac_addresses": {
      "items": {
        "$ref": "MACAddress"+
      }, 
      "maxItems": 4000, 
      "required": false, 
      "title": "MAC addresses", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Set of one or more MAC addresses", 
  "type": "object"
}

MACSetListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "MACSetListRequestParameters", 
  "module_id": "MACSet", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "MACSet list request parameters", 
  "type": "object"
}

MACSetListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "MACSetListResult", 
  "module_id": "MACSet", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MACSet"+
      }, 
      "required": true, 
      "title": "Paged collection of MACSets", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MacAddressCsvListResult (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "MacAddressCsvListResult", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "MacTableCsvRecord"+
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

MacAddressListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "MacAddressListResult", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the logical Switch", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MacTableEntry"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MacAddressType (type) 

{
  "enum": [
    "STATIC", 
    "LEARNED"
  ], 
  "id": "MacAddressType", 
  "module_id": "AggSvcLogicalPort", 
  "title": "The type of the MAC address", 
  "type": "string"
}

MacLearningSpec (type) 

{
  "additionalProperties": false, 
  "id": "MacLearningSpec", 
  "module_id": "MacManagementSwitchingProfile", 
  "properties": {
    "aging_time": {
      "default": 300, 
      "readonly": true, 
      "required": false, 
      "title": "Aging time in sec for learned MAC address", 
      "type": "int"
    }, 
    "enabled": {
      "readonly": false, 
      "required": true, 
      "title": "Allowing source MAC address learning", 
      "type": "boolean"
    }, 
    "limit": {
      "default": 4096, 
      "maximum": 4096, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "The maximum number of MAC addresses that can be learned on this port", 
      "type": "int"
    }, 
    "limit_policy": {
      "default": "ALLOW", 
      "enum": [
        "ALLOW", 
        "DROP"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "The policy after MAC Limit is exceeded", 
      "type": "string"
    }, 
    "unicast_flooding_allowed": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Allowing flooding for unlearned MAC for ingress traffic", 
      "type": "boolean"
    }
  }, 
  "title": "MAC learning configuration", 
  "type": "object"
}

MacManagementSwitchingProfile (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseSwitchingProfile"+
  }, 
  "id": "MacManagementSwitchingProfile", 
  "module_id": "MacManagementSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "MacManagementSwitchingProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mac_change_allowed": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Allowing source MAC address change", 
      "type": "boolean"
    }, 
    "mac_learning": {
      "$ref": "MacLearningSpec"+, 
      "readonly": false, 
      "required": false, 
      "title": "MAC learning configuration"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

MacPool (type) 

{
  "additionalProperties": false, 
  "description": "A collection of ranges of MAC addresses", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "MacPool", 
  "module_id": "MACAM", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ranges": {
      "items": {
        "$ref": "MacRange"+
      }, 
      "required": true, 
      "title": "Array of ranges for MAC addresses", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

MacPoolListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "MacPoolListResult", 
  "module_id": "MACAM", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MacPool"+
      }, 
      "required": true, 
      "title": "MAC pool list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MacRange (type) 

{
  "additionalProperties": false, 
  "description": "A range of MAC addresses with a start and end value", 
  "id": "MacRange", 
  "module_id": "MACAM", 
  "properties": {
    "end": {
      "$ref": "MACAddress"+, 
      "description": "End value for MAC address range", 
      "readonly": false, 
      "required": true, 
      "title": "End value of MAC range"
    }, 
    "start": {
      "$ref": "MACAddress"+, 
      "description": "Start value for MAC address range", 
      "readonly": false, 
      "required": true, 
      "title": "Start value of MAC range"
    }
  }, 
  "type": "object"
}

MacTableCsvRecord (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "MacTableCsvRecord", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "vtep_ip": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "The virtual tunnel endpoint IP address"
    }, 
    "vtep_mac_address": {
      "required": false, 
      "title": "The virtual tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MacTableEntry (type) 

{
  "id": "MacTableEntry", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "mac_address": {
      "required": true, 
      "title": "The MAC address", 
      "type": "string"
    }, 
    "vtep_ip": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "The virtual tunnel endpoint IP address"
    }, 
    "vtep_mac_address": {
      "required": false, 
      "title": "The virtual tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MaintenanceModeState (type) 

{
  "enum": [
    "ENTERING", 
    "ENABLED", 
    "EXITING", 
    "DISABLED"
  ], 
  "id": "MaintenanceModeState", 
  "module_id": "TransportNode", 
  "readonly": true, 
  "title": "maintenance mode state", 
  "type": "string"
}

ManagedResource (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "ManagedResource", 
  "module_id": "Common", 
  "polymorphic-type-descriptor": {
    "property-name": "resource_type"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base type for resources that are managed by API clients", 
  "type": "object"
}

ManagementClusterNodeStatus (type) 

{
  "additionalProperties": false, 
  "id": "ManagementClusterNodeStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "mgmt_cluster_status": {
      "$ref": "ClusteringStatus"+, 
      "readonly": true, 
      "title": "Status of this node's connection to the management cluster"
    }
  }, 
  "type": "object"
}

ManagementClusterRoleConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ClusterRoleConfig"+
  }, 
  "id": "ManagementClusterRoleConfig", 
  "module_id": "ClusterManagement", 
  "properties": {
    "api_listen_addr": {
      "$ref": "ServiceEndpoint"+, 
      "readonly": true, 
      "title": "The IP and port for the public API service on this node"
    }, 
    "mgmt_cluster_listen_addr": {
      "$ref": "ServiceEndpoint"+, 
      "readonly": true, 
      "title": "The IP and port for the management cluster service on this node"
    }, 
    "mgmt_plane_listen_addr": {
      "$ref": "ServiceEndpoint"+, 
      "readonly": true, 
      "title": "The IP and port for the management plane service on this node"
    }, 
    "mpa_msg_client_info": {
      "$ref": "MsgClientInfo"+
    }, 
    "type": {
      "enum": [
        "ManagementClusterRoleConfig", 
        "ControllerClusterRoleConfig"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type of this role configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ManagementClusterStatus (type) 

{
  "additionalProperties": false, 
  "id": "ManagementClusterStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "offline_nodes": {
      "description": "Current missing management plane nodes", 
      "items": {
        "$ref": "ManagementPlaneBaseNodeInfo"+
      }, 
      "readonly": true, 
      "type": "array"
    }, 
    "online_nodes": {
      "description": "Current alive management plane nodes", 
      "items": {
        "$ref": "ManagementPlaneBaseNodeInfo"+
      }, 
      "readonly": true, 
      "type": "array"
    }, 
    "required_members_for_initialization": {
      "description": "The details of the cluster nodes required for cluster initialization", 
      "items": {
        "$ref": "ClusterInitializationNodeInfo"+
      }, 
      "readonly": true, 
      "type": "array"
    }, 
    "status": {
      "enum": [
        "INITIALIZING", 
        "UNSTABLE", 
        "STABLE", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "The current status of the management cluster", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ManagementConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "ManagementConfig", 
  "module_id": "ConfigManagement", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "publish_fqdns": {
      "required": true, 
      "title": "True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability.", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

ManagementNodeAggregateInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BaseNodeAggregateInfo"+
  }, 
  "id": "ManagementNodeAggregateInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "display_name": {
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "node_interface_properties": {
      "items": {
        "$ref": "NodeInterfaceProperties"+
      }, 
      "readonly": true, 
      "title": "Array of Node interface statistic properties", 
      "type": "array"
    }, 
    "node_interface_statistics": {
      "items": {
        "$ref": "NodeInterfaceStatisticsProperties"+
      }, 
      "readonly": true, 
      "title": "Array of Node network interface statistic properties", 
      "type": "array"
    }, 
    "node_status": {
      "$ref": "ClusterNodeStatus"+, 
      "readonly": true
    }, 
    "node_status_properties": {
      "items": {
        "$ref": "NodeStatusProperties"+
      }, 
      "title": "Time series of the node's system properties", 
      "type": "array"
    }, 
    "role_config": {
      "$ref": "ManagementClusterRoleConfig"+, 
      "readonly": true
    }, 
    "transport_nodes_connected": {
      "minimum": 0, 
      "readonly": true, 
      "type": "integer"
    }
  }, 
  "type": "object"
}

ManagementPlaneBaseNodeInfo (type) 

{
  "description": "The basic node info of management plane node", 
  "id": "ManagementPlaneBaseNodeInfo", 
  "module_id": "ClusterManagement", 
  "properties": {
    "mgmt_cluster_listen_ip_address": {
      "readonly": true, 
      "title": "The IP address of MP node", 
      "type": "string"
    }, 
    "uuid": {
      "readonly": true, 
      "title": "Management plane node UUID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MandatoryAccessControlProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "MandatoryAccessControlProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "enabled": {
      "description": "Enabled can be True/False", 
      "type": "boolean"
    }, 
    "status": {
      "description": "current status of Mandatory Access Control", 
      "enum": [
        "ENABLED", 
        "DISABLED", 
        "ENABLED_PENDING_REBOOT"
      ], 
      "readonly": true, 
      "type": "string"
    }
  }, 
  "title": "Information about mandatory access control", 
  "type": "object"
}

MetadataProxy (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "MetadataProxy", 
  "module_id": "MetadataProxy", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attached_logical_port_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of attached logical port", 
      "type": "string"
    }, 
    "crypto_protocols": {
      "description": "The cryptographic protocols listed here are supported by the metadata proxy.\nThe TLSv1.1 and TLSv1.2 are supported by default.\n", 
      "items": {
        "$ref": "MetadataProxyCryptoProtocol"+
      }, 
      "readonly": false, 
      "required": false, 
      "title": "metadata proxy supported cryptographic protocols.", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "edge_cluster_id": {
      "required": true, 
      "title": "edge cluster uuid", 
      "type": "string"
    }, 
    "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", 
      "items": {
        "type": "integer"
      }, 
      "maxItems": 2, 
      "minItems": 0, 
      "required": false, 
      "title": "edge cluster member indexes", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "metadata_server_ca_ids": {
      "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", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "uuids of CAs to verify metadata server certificate", 
      "type": "array"
    }, 
    "metadata_server_url": {
      "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", 
      "required": true, 
      "title": "metadata server url", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "secret": {
      "required": false, 
      "title": "secret to access metadata server", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

MetadataProxyCryptoProtocol (type) 

{
  "additionalProperties": false, 
  "enum": [
    "TLS_V1", 
    "TLS_V1_1", 
    "TLS_V1_2"
  ], 
  "id": "MetadataProxyCryptoProtocol", 
  "module_id": "MetadataProxy", 
  "title": "Metadata proxy supported cryptographic protocol", 
  "type": "string"
}

MetadataProxyListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "MetadataProxyListResult", 
  "module_id": "MetadataProxy", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "MetadataProxy"+
      }, 
      "required": true, 
      "title": "paginated list of metadata proxies", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MetadataProxyStatisticsRequestParameters (type) 

{
  "extends": {
    "$ref": "DataSourceParameters"+
  }, 
  "id": "MetadataProxyStatisticsRequestParameters", 
  "module_id": "AggSvcMetadataProxy", 
  "properties": {
    "logical_switch_id": {
      "required": false, 
      "title": "The uuid of logical switch", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "type": "object"
}

MgmtConnStatus (type) 

{
  "additionalProperties": false, 
  "id": "MgmtConnStatus", 
  "module_id": "ClusterManagement", 
  "properties": {
    "connectivity_status": {
      "enum": [
        "CONNECTED", 
        "DISCONNECTED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "title": "Indicates the controller node's MP channel connectivity status", 
      "type": "string"
    }
  }, 
  "type": "object"
}

MirrorDestination (type) 

{
  "abstract": true, 
  "id": "MirrorDestination", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "$ref": "MirrorDestinationResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorDestination'", 
      "required": true
    }
  }, 
  "type": "object"
}

MirrorDestinationResourceType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "LogicalPortMirrorDestination", 
    "PnicMirrorDestination", 
    "IPMirrorDestination"
  ], 
  "id": "MirrorDestinationResourceType", 
  "module_id": "PortMirroring", 
  "title": "Resource types of mirror destination", 
  "type": "string"
}

MirrorSource (type) 

{
  "abstract": true, 
  "id": "MirrorSource", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "$ref": "MirrorSourceResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorSource', 'PnicMirrorSource'", 
      "required": true
    }
  }, 
  "type": "object"
}

MirrorSourceResourceType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "LogicalPortMirrorSource", 
    "PnicMirrorSource", 
    "VlanMirrorSource", 
    "LogicalSwitchMirrorSource"
  ], 
  "id": "MirrorSourceResourceType", 
  "module_id": "PortMirroring", 
  "title": "Resource types of mirror source", 
  "type": "string"
}

MonitorQueryType (type) 

{
  "additionalProperties": false, 
  "description": "MonitorQueryType is used to query load balancer monitors.\nLbActiveMonitor represents active load balancer monitors.\nWhile LbActiveMonitor is specified to query load balancer\nmonitors, it returns all active monitors, including LbHttpMonitor,\nLbHttpMonitor, LbIcmpMonitor, LbTcpMonitor,\nLbUdpMonitor.\n", 
  "enum": [
    "LbHttpMonitor", 
    "LbHttpsMonitor", 
    "LbIcmpMonitor", 
    "LbTcpMonitor", 
    "LbUdpMonitor", 
    "LbPassiveMonitor", 
    "LbActiveMonitor"
  ], 
  "id": "MonitorQueryType", 
  "module_id": "LoadBalancer", 
  "title": "monitor query type", 
  "type": "string"
}

MonitorType (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "MonitorType", 
  "module_id": "LoadBalancer", 
  "title": "monitor type", 
  "type": "string"
}

MonthlyTelemetrySchedule (type) 

{
  "extends": {
    "$ref": "TelemetrySchedule"+
  }, 
  "id": "MonthlyTelemetrySchedule", 
  "module_id": "TelemetryConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "MonthlyTelemetrySchedule"
  }, 
  "properties": {
    "day_of_month": {
      "description": "Day of month on which data will be collected. Specify a value between 1 through 31.\n", 
      "maximum": 31, 
      "minimum": 1, 
      "required": true, 
      "title": "Day of month on which data will be collected", 
      "type": "integer"
    }, 
    "frequency_type": {
      "description": "Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.", 
      "required": true, 
      "title": "Frequency at which data will be collected", 
      "type": "string"
    }, 
    "hour_of_day": {
      "description": "Hour at which data will be collected. Specify a value between 0 through 23.\n", 
      "maximum": 23, 
      "minimum": 0, 
      "required": true, 
      "title": "Hour at which data will be collected", 
      "type": "integer"
    }, 
    "minutes": {
      "default": 0, 
      "description": "Minute at which data will be collected. Specify a value between 0 through 59.\n", 
      "maximum": 59, 
      "minimum": 0, 
      "required": false, 
      "title": "Minute at which data will be collected", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

MsgClientInfo (type) 

{
  "id": "MsgClientInfo", 
  "module_id": "Common", 
  "properties": {
    "account_name": {
      "description": "Account name for the messaging client. Identifies the client on the management plane message bus.", 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "certificate": {
      "description": "Messaging client's certificate. Used to authenticate to the control plane messaging endpoint.", 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "shared_secret": {
      "description": "Messaging client's secret. Used to authenticate to the management plane messaging broker.", 
      "readonly": false, 
      "required": false, 
      "type": "string"
    }, 
    "software_version": {
      "description": "Software version of the node.", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "title": "Information about a messaging client", 
  "type": "object"
}

MultiWidgetConfiguration (type) 

{
  "additionalProperties": false, 
  "description": "Combines two or more widgetconfigurations into a multi-widget", 
  "extends": {
    "$ref": "WidgetConfiguration"+
  }, 
  "id": "MultiWidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "MultiWidgetConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "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.", 
      "items": {
        "$ref": "Datasource"+
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "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.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "footer": {
      "$ref": "Footer"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }, 
    "widgets": {
      "description": "Array of widgets that are part of the multi-widget.", 
      "items": {
        "$ref": "WidgetItem"+
      }, 
      "maxItems": 2, 
      "minItems": 1, 
      "required": true, 
      "title": "Widgets", 
      "type": "array"
    }
  }, 
  "title": "Multi-Widget", 
  "type": "object"
}

NSGroup (type) 

{
  "additionalProperties": false, 
  "description": "NSGroups are recursive groupings of different NSX elements (logical and physical), typically used in policy definitions.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "NSGroup", 
  "module_id": "NSGroup", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "member_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of the members added to this NSGroup", 
      "type": "integer"
    }, 
    "members": {
      "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", 
      "items": {
        "$ref": "NSGroupSimpleExpression"+
      }, 
      "maxItems": 500, 
      "required": false, 
      "title": "Members of NSGroup", 
      "type": "array"
    }, 
    "membership_criteria": {
      "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.\n", 
      "items": {
        "$ref": "NSGroupExpression"+
      }, 
      "maxItems": 5, 
      "required": false, 
      "title": "The criteria for membership of this NSGroup", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Networking and Security Group", 
  "type": "object"
}

NSGroupComplexExpression (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSGroupExpression"+
  }, 
  "id": "NSGroupComplexExpression", 
  "module_id": "NSGroup", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NSGroupComplexExpression"
  }, 
  "properties": {
    "expressions": {
      "description": "Represents expressions which are to be logically 'AND'ed.The array cannot contain\nNSGroupComplexExpression.Only NSGroupTagExpression and NSGroupSimpleExpressions\nare accepted.\n", 
      "items": {
        "$ref": "NSGroupExpression"+
      }, 
      "maxItems": 5, 
      "minItems": 2, 
      "required": true, 
      "title": "List of simple and tag expressions", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "NSGroupSimpleExpression", 
        "NSGroupComplexExpression", 
        "NSGroupTagExpression"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Complex expressions to represent NSGroup membership", 
  "type": "object"
}

NSGroupExpression (type) 

{
  "id": "NSGroupExpression", 
  "module_id": "NSGroup", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "NSGroupSimpleExpression", 
        "NSGroupComplexExpression", 
        "NSGroupTagExpression"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Policy expression for NSGroup membership", 
  "type": "object"
}

NSGroupListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NSGroupListRequestParameters", 
  "module_id": "NSGroup", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "member_types": {
      "description": "Specify valid member types in CSV format to filter NSGroups. Returns NSGroups\nwhose member types are same as or subset of specified member types\n", 
      "required": false, 
      "title": "Specify member types to filter corresponding NSGroups\n", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "populate_references": {
      "default": false, 
      "description": "If set to true, the target_resource property of each\nNSGroupExpresion will be populated from the associated resource\nwhen the expression uniquely identifies a resource.\n", 
      "title": "Populate metadata of resource referenced by NSGroupExpressions\n", 
      "type": "boolean"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NSGroup list request parameters", 
  "type": "object"
}

NSGroupListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NSGroupListResult", 
  "module_id": "NSGroup", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NSGroup"+
      }, 
      "required": true, 
      "title": "NSGroup list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of NSGroups", 
  "type": "object"
}

NSGroupMetaInfo (type) 

{
  "description": "Contains the metadata of a NSGroup when the application discovery session\nwas started\n", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NSGroupMetaInfo", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "no_of_vms": {
      "required": false, 
      "title": "Number of VMs discovered for this NSGroup when session was started", 
      "type": "integer"
    }, 
    "ns_group_id": {
      "required": true, 
      "title": "ID of the NS Group", 
      "type": "string"
    }
  }, 
  "title": "Metadata about NSGroup", 
  "type": "object"
}

NSGroupMetaInfoListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NSGroupMetaInfoListResult", 
  "module_id": "AppDiscovery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NSGroupMetaInfo"+
      }, 
      "required": true, 
      "title": "list of NSGroupMetaInfos", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NSGroupMetaInfo list", 
  "type": "object"
}

NSGroupServiceAssociationListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NSGroupServiceAssociationListRequestParameters", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "fetch_parentgroup_associations": {
      "default": false, 
      "description": "If set to true, will fetch direct as well as\nindirect associated service entities for the given NSGroup.\n", 
      "required": false, 
      "title": "Fetch complete list of associated resources considering\nnesting\n", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "service_type": {
      "enum": [
        "firewall", 
        "ipfix"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NSGroup Service association list request parameters", 
  "type": "object"
}

NSGroupSimpleExpression (type) 

{
  "extends": {
    "$ref": "NSGroupExpression"+
  }, 
  "id": "NSGroupSimpleExpression", 
  "module_id": "NSGroup", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NSGroupSimpleExpression"
  }, 
  "properties": {
    "op": {
      "enum": [
        "EQUALS", 
        "CONTAINS", 
        "STARTSWITH"
      ], 
      "required": true, 
      "title": "Operator of the expression", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NSGroupSimpleExpression", 
        "NSGroupComplexExpression", 
        "NSGroupTagExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "target_property": {
      "required": true, 
      "title": "Field of the resource on which this expression is evaluated", 
      "type": "string"
    }, 
    "target_resource": {
      "$ref": "ResourceReference"+, 
      "description": "Reference of the target. Will be populated when\nthe property is a resource id, the op (operator) is EQUALS and\npopulate_references is set to be true.\n", 
      "readonly": true, 
      "required": false, 
      "title": "Reference of the target"
    }, 
    "target_type": {
      "$ref": "NSGroupValidResourceType"+, 
      "required": true, 
      "title": "Type of the resource on which this expression is evaluated"
    }, 
    "value": {
      "required": true, 
      "title": "Value that satisfies this expression", 
      "type": "string"
    }
  }, 
  "title": "Simple expressions to represent NSGroup membership", 
  "type": "object"
}

NSGroupTagExpression (type) 

{
  "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", 
  "extends": {
    "$ref": "NSGroupExpression"+
  }, 
  "id": "NSGroupTagExpression", 
  "module_id": "NSGroup", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NSGroupTagExpression"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "NSGroupSimpleExpression", 
        "NSGroupComplexExpression", 
        "NSGroupTagExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "maxLength": 128, 
      "required": false, 
      "title": "The tag.scope attribute of the object", 
      "type": "string"
    }, 
    "scope_op": {
      "default": "EQUALS", 
      "enum": [
        "EQUALS"
      ], 
      "required": false, 
      "title": "Operator of the scope expression eg- tag.scope = \"S1\".", 
      "type": "string"
    }, 
    "tag": {
      "maxLength": 256, 
      "required": false, 
      "title": "The tag.tag attribute of the object", 
      "type": "string"
    }, 
    "tag_op": {
      "default": "EQUALS", 
      "enum": [
        "EQUALS"
      ], 
      "required": false, 
      "title": "Operator of the tag expression eg- tag.tag = \"Production\"", 
      "type": "string"
    }, 
    "target_type": {
      "enum": [
        "LogicalSwitch", 
        "LogicalPort", 
        "VirtualMachine"
      ], 
      "required": true, 
      "title": "Type of the resource on which this expression is evaluated", 
      "type": "string"
    }
  }, 
  "title": "TAG expressions to represent NSGroup membership", 
  "type": "object"
}

NSGroupValidResourceType (type) 

{
  "enum": [
    "NSGroup", 
    "IPSet", 
    "MACSet", 
    "LogicalSwitch", 
    "LogicalPort", 
    "VirtualMachine", 
    "DirectoryGroup"
  ], 
  "id": "NSGroupValidResourceType", 
  "module_id": "NSGroup", 
  "title": "Resource type valid for use in an NSGroupExpression", 
  "type": "string"
}

NSService (type) 

{
  "additionalProperties": false, 
  "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", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "NSService", 
  "module_id": "NSService", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "default_service": {
      "description": "The default NSServices are created in the system by default. These NSServices\ncan't be modified/deleted\n", 
      "readonly": true, 
      "title": "NSServices created in the system by default", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "nsservice_element": {
      "$ref": "NSServiceElement"+, 
      "required": true, 
      "title": "An NSService Element that describes traffic corresponding to this NSService"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

NSServiceElement (type) 

{
  "abstract": true, 
  "id": "NSServiceElement", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "title": "The specific type of NSServiceElement", 
      "type": "string"
    }
  }, 
  "title": "An NSService element that describes traffic corresponding to an NSService", 
  "type": "object"
}

NSServiceGroup (type) 

{
  "additionalProperties": false, 
  "description": "A Networking and Security Service Group that represents a group of NSServices\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "NSServiceGroup", 
  "module_id": "NSServiceGroup", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "default_service": {
      "description": "The default NSServiceGroups are created in the system by default. These\nNSServiceGroups can't be modified/deleted\n", 
      "readonly": true, 
      "title": "NSServiceGroups created in the system by default", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "members": {
      "description": "List of NSService or NSServiceGroup resources that can be added as members\nto an NSServiceGroup.\n", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 50, 
      "required": true, 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "service_type": {
      "enum": [
        "ETHER", 
        "NON_ETHER"
      ], 
      "readonly": true, 
      "title": "Type of the NSServiceGroup", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

NSServiceGroupListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NSServiceGroupListRequestParameters", 
  "module_id": "NSServiceGroup", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "default_service": {
      "description": "If set to true, then it will display only default\nNSServiceGroups. If set to false, then it will display all those\nNSServiceGroups which are not default. If it is not provided,\nthen complete (default as well as non default) list of\nNSServiceGroups will be displayed.\n", 
      "title": "Fetch all default NSServiceGroups", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NSServiceGroup list request parameters", 
  "type": "object"
}

NSServiceGroupListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NSServiceGroupListResult", 
  "module_id": "NSServiceGroup", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NSServiceGroup"+
      }, 
      "required": true, 
      "title": "Paged collection of NSServiceGroups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List result of NSServiceGroups", 
  "type": "object"
}

NSServiceListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NSServiceListRequestParameters", 
  "module_id": "NSService", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "default_service": {
      "description": "If set to true, then it will display only default NSServices. If\nset to false, then it will display all those NSServices which are not\ndefault. If it is not provided, then complete (default\nas well as non default) list of NSServices will be displayed.\n", 
      "title": "Fetch all default NSServices", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NSService list request parameters.", 
  "type": "object"
}

NSServiceListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NSServiceListResult", 
  "module_id": "NSService", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NSService"+
      }, 
      "required": true, 
      "title": "Paged collection of NSServices", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List result of NSservices", 
  "type": "object"
}

NamedTeamingPolicy (type) 

{
  "extends": {
    "$ref": "TeamingPolicy"+
  }, 
  "id": "NamedTeamingPolicy", 
  "module_id": "UplinkHostSwitchProfile", 
  "properties": {
    "active_list": {
      "items": {
        "$ref": "Uplink"+
      }, 
      "required": true, 
      "title": "List of Uplinks used in active list", 
      "type": "array"
    }, 
    "name": {
      "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.", 
      "required": true, 
      "title": "The name of the uplink teaming policy", 
      "type": "string"
    }, 
    "policy": {
      "enum": [
        "FAILOVER_ORDER", 
        "LOADBALANCE_SRCID"
      ], 
      "required": true, 
      "title": "Teaming policy", 
      "type": "string"
    }, 
    "standby_list": {
      "items": {
        "$ref": "Uplink"+
      }, 
      "required": false, 
      "title": "List of Uplinks used in standby list", 
      "type": "array"
    }
  }, 
  "title": "Uplink Teaming Policy with a name that can be referenced by logical switches", 
  "type": "object"
}

NatActions (type) 

{
  "additionalProperties": false, 
  "description": "NAT action types. Please note, the NO_NAT was deprecated. Please use the\nalternative NO_SNAT or NO_DNAT.\n", 
  "enum": [
    "SNAT", 
    "DNAT", 
    "NO_NAT", 
    "REFLEXIVE", 
    "NO_SNAT", 
    "NO_DNAT"
  ], 
  "id": "NatActions", 
  "module_id": "Nat", 
  "title": "NAT action types", 
  "type": "string"
}

NatRule (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "NatRule", 
  "module_id": "Nat", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "$ref": "NatActions"+, 
      "description": "valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE. All rules\nin a logical router are either stateless or stateful. Mix is not\nsupported. 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", 
      "required": true, 
      "title": "NAT rule action type."
    }, 
    "applied_tos": {
      "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.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "List of LogicalRouterPort resources as applied to", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "required": false, 
      "title": "enable/disable the rule", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logging": {
      "default": false, 
      "required": false, 
      "title": "enable/disable the logging of rule", 
      "type": "boolean"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "match_destination_network": {
      "description": "IP Address | CIDR | (null implies Any)\n", 
      "required": false, 
      "title": "match destination network", 
      "type": "string"
    }, 
    "match_service": {
      "$ref": "NSServiceElement"+, 
      "description": "A NSServiceElement that specifies the matching services of source\nports, destination ports, ip protocol version and number, sub protocol\nversion and number, ICMP type and code, etc.\nThe match_service can be one of IPProtocolNSService,L4PortSetNSService\nor ICMPTypeNSService. REFLEXIVE NAT does not support match_service.\n", 
      "required": false, 
      "title": "match service on source port, destination port, protocol, icmp, etc"
    }, 
    "match_source_network": {
      "description": "IP Address | CIDR | (null implies Any)\n", 
      "required": false, 
      "title": "match source network", 
      "type": "string"
    }, 
    "nat_pass": {
      "default": true, 
      "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_NAT, then nat_pass\nmust be set to true or omitted.\n", 
      "required": false, 
      "title": "enable/disable to bypass following firewall stage", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_priority": {
      "default": 1024, 
      "description": "Ascending, valid range [0-2147483647]. If multiple rules have the same\npriority, evaluation sequence is undefined.\n", 
      "required": false, 
      "title": "NAT rule priority", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "translated_network": {
      "required": false, 
      "title": "IP Address | IP Range | CIDR", 
      "type": "string"
    }, 
    "translated_ports": {
      "required": false, 
      "title": "port number or port range. DNAT only", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NatRuleListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NatRuleListResult", 
  "module_id": "Nat", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NatRule"+
      }, 
      "required": true, 
      "title": "NAT rule list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NeighborProperties (type) 

{
  "additionalProperties": false, 
  "id": "NeighborProperties", 
  "module_id": "Lldp", 
  "properties": {
    "capabilities": {
      "display": {
        "order": 6
      }, 
      "readonly": true, 
      "title": "Capabilities", 
      "type": "string"
    }, 
    "enabled_capabilities": {
      "display": {
        "order": 7
      }, 
      "readonly": true, 
      "title": "Enabled capabilities", 
      "type": "string"
    }, 
    "ifindex": {
      "display": {
        "order": 9
      }, 
      "readonly": true, 
      "title": "Interface index", 
      "type": "integer"
    }, 
    "link_aggregation_capable": {
      "display": {
        "order": 12
      }, 
      "readonly": true, 
      "title": "Aggregation Capability", 
      "type": "boolean"
    }, 
    "link_aggregation_port_id": {
      "display": {
        "order": 14
      }, 
      "readonly": true, 
      "title": "Aggregation port id", 
      "type": "string"
    }, 
    "link_aggregation_status": {
      "description": "True if currently in aggregation", 
      "display": {
        "order": 13
      }, 
      "readonly": true, 
      "title": "Aggregation Status", 
      "type": "boolean"
    }, 
    "mac": {
      "display": {
        "order": 2
      }, 
      "pattern": "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$", 
      "readonly": true, 
      "title": "Interface MAC address", 
      "type": "string"
    }, 
    "mgmt_addr": {
      "display": {
        "order": 8
      }, 
      "readonly": true, 
      "title": "Management address", 
      "type": "string"
    }, 
    "name": {
      "display": {
        "order": 1
      }, 
      "readonly": true, 
      "title": "Interface name", 
      "type": "string"
    }, 
    "oid": {
      "display": {
        "order": 11
      }, 
      "readonly": true, 
      "title": "Object identifier", 
      "type": "string"
    }, 
    "port_desc": {
      "display": {
        "order": 3
      }, 
      "readonly": true, 
      "title": "Port description", 
      "type": "string"
    }, 
    "system_desc": {
      "display": {
        "order": 5
      }, 
      "readonly": true, 
      "title": "System description", 
      "type": "string"
    }, 
    "system_name": {
      "display": {
        "order": 4
      }, 
      "readonly": true, 
      "title": "System name", 
      "type": "string"
    }, 
    "system_port_number": {
      "display": {
        "order": 10
      }, 
      "readonly": true, 
      "title": "System port number", 
      "type": "integer"
    }
  }, 
  "title": "Neighbor properties", 
  "type": "object"
}

NetworkMigrationSpec (type) 

{
  "abstract": true, 
  "description": "The NetworkMigrationSpec is the base class for any types of network migration\nspecifications to be handled by transport node.\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "NetworkMigrationSpec", 
  "module_id": "TransportNode", 
  "nsx_feature": "HostProfileSupport", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "NetworkMigrationSpecType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Abstract base type for network migration specification", 
  "type": "object"
}

NetworkMigrationSpecListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NetworkMigrationSpecListParameters", 
  "module_id": "TransportNode", 
  "nsx_feature": "HostProfileSupport", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_system_owned": {
      "default": false, 
      "required": false, 
      "title": "Whether the list result contains system resources", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "$ref": "NetworkMigrationSpecType"+, 
      "required": false, 
      "title": "Type of network migration specification."
    }
  }, 
  "title": "NetworkMigrationSpec List Parameters", 
  "type": "object"
}

NetworkMigrationSpecListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NetworkMigrationSpecListResult", 
  "module_id": "TransportNode", 
  "nsx_feature": "HostProfileSupport", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NetworkMigrationSpec"+
      }, 
      "readonly": true, 
      "title": "Network migration specification template results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Network migration specification template list result", 
  "type": "object"
}

NetworkMigrationSpecType (type) 

{
  "enum": [
    "HostProfileNetworkMigrationSpec"
  ], 
  "id": "NetworkMigrationSpecType", 
  "module_id": "TransportNode", 
  "nsx_feature": "HostProfileSupport", 
  "title": "Supported network migration specification types.", 
  "type": "string"
}

NetworkMigrationSpecTypeIdEntry (type) 

{
  "id": "NetworkMigrationSpecTypeIdEntry", 
  "module_id": "TransportNode", 
  "nsx_feature": "HostProfileSupport", 
  "properties": {
    "key": {
      "$ref": "NetworkMigrationSpecType"+, 
      "description": "the type of the NetworkMigrationSpec", 
      "readonly": true
    }, 
    "value": {
      "description": "the id of the NetworkMigrationSpec", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

NicInfo (type) 

{
  "description": "Information of a network interface present on the partner appliance that needs to be configured by the NSX Manager.", 
  "id": "NicInfo", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "gateway_address": {
      "description": "Gateway address associated with the NIC metadata.", 
      "readonly": false, 
      "required": false, 
      "title": "Gateway address", 
      "type": "string"
    }, 
    "ip_address": {
      "description": "IP address associated with the NIC metadata.", 
      "readonly": false, 
      "required": false, 
      "title": "IP address", 
      "type": "string"
    }, 
    "network_id": {
      "description": "Network Id associated with the NIC metadata.", 
      "readonly": false, 
      "required": false, 
      "title": "Network Id", 
      "type": "string"
    }, 
    "nic_metadata": {
      "$ref": "NicMetadata"+, 
      "description": "NIC metadata information.", 
      "readonly": true, 
      "required": true, 
      "title": "NIC metadata"
    }, 
    "subnet_mask": {
      "description": "Subnet mask associated with the NIC metadata.", 
      "readonly": false, 
      "required": false, 
      "title": "Subnet mask", 
      "type": "string"
    }
  }, 
  "title": "NIC information", 
  "type": "object"
}

NicMetadata (type) 

{
  "description": "Information on the Network interfaces present on the partner appliance that needs to be configured by the NSX Manager.", 
  "id": "NicMetadata", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "interface_index": {
      "description": "Network Interface index.", 
      "readonly": false, 
      "required": true, 
      "title": "Interface Index", 
      "type": "integer"
    }, 
    "interface_label": {
      "description": "Network Interface label.", 
      "readonly": false, 
      "required": true, 
      "title": "Interface label", 
      "type": "string"
    }, 
    "interface_type": {
      "description": "Interface that needs to be configured on the partner appliance. Ex. MANAGEMENT, DATA1, DATA2, HA1, HA2.", 
      "enum": [
        "MANAGEMENT", 
        "DATA1", 
        "DATA2", 
        "HA1", 
        "HA2"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Interface type", 
      "type": "string"
    }
  }, 
  "title": "NIC Metadata", 
  "type": "object"
}

NiocProfile (type) 

{
  "description": "This profile is created for Network I/O Control(NIOC).\n", 
  "extends": {
    "$ref": "BaseHostSwitchProfile"+
  }, 
  "id": "NiocProfile", 
  "module_id": "NiocProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NiocProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "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", 
      "nsx_feature": "Nioc", 
      "required": false, 
      "title": "Enabled status of NIOC feature", 
      "type": "boolean"
    }, 
    "host_infra_traffic_res": {
      "description": "host_infra_traffic_res specifies bandwidth allocation for\nvarious traffic resources.\n", 
      "items": {
        "$ref": "ResourceAllocation"+
      }, 
      "nsx_feature": "Nioc", 
      "required": false, 
      "title": "Resource allocation associated with NiocProfile", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "HostSwitchProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Profile for Nioc", 
  "type": "object"
}

NoRestRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "Parameter definition for requests that do not allow parameters.", 
  "id": "NoRestRequestParameters", 
  "module_id": "Types", 
  "properties": {}, 
  "type": "object"
}

Node (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "Node", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_ip_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Discovered IP Addresses of the fabric node, version 4 or 6", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "ID of the Node maintained on the Node and used to recognize the Node", 
      "type": "string"
    }, 
    "fqdn": {
      "readonly": true, 
      "required": false, 
      "title": "Fully qualified domain name of the fabric node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "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", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": false, 
      "title": "IP Addresses of the Node, version 4 or 6", 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'", 
      "required": true, 
      "title": "Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

NodeAggregateInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "NodeAggregateInfo", 
  "module_id": "NsxQuery", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "node": {
      "$ref": "Node"+, 
      "description": "Node attributes", 
      "readonly": true
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "NodeStatus"+, 
      "description": "Node status", 
      "readonly": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Aggregation of desired and runtime status of fabric node", 
  "type": "object"
}

NodeAggregateInfoListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeAggregateInfoListResult", 
  "module_id": "NsxQuery", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeAggregateInfo"+
      }, 
      "required": true, 
      "title": "Node Aggregate Info Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node aggregate state list result", 
  "type": "object"
}

NodeAggregationListRequestParameters (type) 

{
  "description": "Request object, containing two properties, based on\nwhich the result will be filtered. None, or only one,\nor both the properties can be passed as filter criteria.\nIf both properties are populated then result will be\nthe intersection of two resulsets by applying both\nfilters individually.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NodeAggregationListRequestParameters", 
  "module_id": "NsxQuery", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "node_deployment_status": {
      "description": "List nodes based on deployment status of fabric nodes,\nif not provided then lists all discovered and fabric nodes\nirrespective of the fabric node status\n", 
      "enum": [
        "SUCCESSFUL", 
        "ERROR", 
        "UNKNOWN"
      ], 
      "required": false, 
      "title": "Install/Uninstall status of deployment", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_nodes": {
      "required": false, 
      "title": "filter whether fabric node is configured as transport node or not, true or false", 
      "type": "boolean"
    }
  }, 
  "title": "Node list parameters", 
  "type": "object"
}

NodeAuthProviderVidmProperties (type) 

{
  "additionalProperties": false, 
  "id": "NodeAuthProviderVidmProperties", 
  "properties": {
    "client_id": {
      "required": true, 
      "title": "vIDM client id", 
      "type": "string"
    }, 
    "client_secret": {
      "required": false, 
      "sensitive": true, 
      "title": "vIDM client secret", 
      "type": "string"
    }, 
    "host_name": {
      "required": true, 
      "title": "Fully Qualified Domain Name(FQDN) of vIDM", 
      "type": "string"
    }, 
    "node_host_name": {
      "description": "host name to use when creating the redirect URL for clients to follow after authenticating to vIDM", 
      "required": true, 
      "title": "host name of the node redirected to", 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Hexadecimal SHA256 hash of the vIDM server's X.509 certificate", 
      "required": true, 
      "title": "vIDM certificate thumbprint", 
      "type": "string"
    }, 
    "vidm_enable": {
      "required": false, 
      "title": "vIDM enable flag", 
      "type": "boolean"
    }
  }, 
  "title": "Node AAA provider vIDM properties", 
  "type": "object"
}

NodeAuthProviderVidmStatus (type) 

{
  "additionalProperties": false, 
  "id": "NodeAuthProviderVidmStatus", 
  "properties": {
    "runtime_state": {
      "required": true, 
      "title": "AAA provider vIDM status", 
      "type": "string"
    }, 
    "vidm_enable": {
      "required": true, 
      "title": "vIDM enable flag", 
      "type": "boolean"
    }
  }, 
  "title": "Node AAA provider vIDM status", 
  "type": "object"
}

NodeFileSystemProperties (type) 

{
  "additionalProperties": false, 
  "id": "NodeFileSystemProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "file_system": {
      "readonly": true, 
      "title": "File system id", 
      "type": "string"
    }, 
    "mount": {
      "readonly": true, 
      "title": "File system mount", 
      "type": "string"
    }, 
    "total": {
      "readonly": true, 
      "title": "File system size in kilobytes", 
      "type": "integer"
    }, 
    "type": {
      "readonly": true, 
      "title": "File system type", 
      "type": "string"
    }, 
    "used": {
      "readonly": true, 
      "title": "Amount of file system used in kilobytes", 
      "type": "integer"
    }
  }, 
  "title": "File system properties", 
  "type": "object"
}

NodeHttpServiceProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties"+
  }, 
  "id": "NodeHttpServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "HttpServiceProperties"+, 
      "title": "HTTP Service properties"
    }
  }, 
  "title": "Node HTTP service properties", 
  "type": "object"
}

NodeIdServicesMap (type) 

{
  "additionalProperties": false, 
  "id": "NodeIdServicesMap", 
  "module_id": "CertificateManager", 
  "properties": {
    "node_id": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "NodeId", 
      "type": "string"
    }, 
    "service_types": {
      "description": "list of ServiceTypes", 
      "items": {
        "$ref": "ServiceType"+
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }
  }, 
  "type": "object"
}

NodeInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "component_version": {
      "readonly": true, 
      "required": true, 
      "title": "Component version of the node", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of the node", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the node", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of node", 
      "type": "string"
    }, 
    "type": {
      "readonly": true, 
      "required": true, 
      "title": "Node type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeInfoListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NodeInfoListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which nodes will be filtered", 
      "type": "string"
    }, 
    "component_version": {
      "readonly": false, 
      "required": false, 
      "title": "Component version based on which nodes will be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeInfoListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeInfoListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeInfo"+
      }, 
      "required": true, 
      "title": "Paged Collection of Nodes", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeInstallUpgradeServiceProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties"+
  }, 
  "id": "NodeInstallUpgradeServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "InstallUpgradeServiceProperties"+, 
      "title": "install-upgrade Service properties"
    }
  }, 
  "title": "Node install-upgrade service properties", 
  "type": "object"
}

NodeInterfaceAlias (type) 

{
  "additionalProperties": false, 
  "id": "NodeInterfaceAlias", 
  "module_id": "ApplianceStats", 
  "properties": {
    "broadcast_address": {
      "$ref": "IPAddress"+, 
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface broadcast address"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface IP address"
    }, 
    "ip_configuration": {
      "enum": [
        "dhcp", 
        "static", 
        "not configured"
      ], 
      "title": "Interface configuration", 
      "type": "string"
    }, 
    "netmask": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface netmask", 
      "type": "string"
    }, 
    "physical_address": {
      "$ref": "MACAddress"+, 
      "title": "Interface MAC address"
    }
  }, 
  "title": "Node network interface alias", 
  "type": "object"
}

NodeInterfaceProperties (type) 

{
  "additionalProperties": false, 
  "id": "NodeInterfaceProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "admin_status": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "title": "Interface administration status", 
      "type": "string"
    }, 
    "connected_switch": {
      "title": "Connected switch", 
      "type": "string"
    }, 
    "ens_capable": {
      "title": "Interface capability for Enhanced Networking Stack", 
      "type": "boolean"
    }, 
    "ens_enabled": {
      "title": "Indicates whether interface is enabled for Enhanced Networking Stack", 
      "type": "boolean"
    }, 
    "interface_alias": {
      "items": {
        "$ref": "NodeInterfaceAlias"+
      }, 
      "title": "IP Alias", 
      "type": "array"
    }, 
    "interface_id": {
      "title": "Interface ID", 
      "type": "string"
    }, 
    "interface_type": {
      "enum": [
        "PHYSICAL", 
        "VIRTUAL"
      ], 
      "title": "Interface Type", 
      "type": "string"
    }, 
    "link_status": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "title": "Interface administration status", 
      "type": "string"
    }, 
    "mtu": {
      "title": "Interface MTU", 
      "type": "integer"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "title": "Source of status data"
    }
  }, 
  "title": "Node network interface properties", 
  "type": "object"
}

NodeInterfacePropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeInterfacePropertiesListResult", 
  "module_id": "ApplianceStats", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeInterfaceProperties"+
      }, 
      "required": true, 
      "title": "Node interface property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node network interface properties list results", 
  "type": "object"
}

NodeInterfaceStatisticsProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeInterfaceStatisticsProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "interface_id": {
      "title": "Interface ID", 
      "type": "string"
    }, 
    "rx_bytes": {
      "title": "Number of bytes received", 
      "type": "integer"
    }, 
    "rx_dropped": {
      "title": "Number of packets dropped", 
      "type": "integer"
    }, 
    "rx_errors": {
      "title": "Number of receive errors", 
      "type": "integer"
    }, 
    "rx_frame": {
      "title": "Number of framing errors", 
      "type": "integer"
    }, 
    "rx_packets": {
      "title": "Number of packets received", 
      "type": "integer"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "title": "Source of status data."
    }, 
    "tx_bytes": {
      "title": "Number of bytes transmitted", 
      "type": "integer"
    }, 
    "tx_carrier": {
      "title": "Number of carrier losses detected", 
      "type": "integer"
    }, 
    "tx_colls": {
      "title": "Number of collisions detected", 
      "type": "integer"
    }, 
    "tx_dropped": {
      "title": "Number of packets dropped", 
      "type": "integer"
    }, 
    "tx_errors": {
      "title": "Number of transmit errors", 
      "type": "integer"
    }, 
    "tx_packets": {
      "title": "Number of packets transmitted", 
      "type": "integer"
    }
  }, 
  "title": "Node network interface statistic properties", 
  "type": "object"
}

NodeListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NodeListRequestParameters", 
  "module_id": "FabricNode", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "discovered_node_id": {
      "required": false, 
      "title": "Id of the discovered node which was converted to create this node", 
      "type": "string"
    }, 
    "display_name": {
      "required": false, 
      "title": "HostNode display name", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "HostNode external id", 
      "type": "string"
    }, 
    "hardware_id": {
      "description": "HardwareId of the host is used to get fabric node on reboot.", 
      "required": false, 
      "title": "Hardware Id of the host", 
      "type": "string"
    }, 
    "hypervisor_os_type": {
      "enum": [
        "ESXI", 
        "RHELKVM", 
        "UBUNTUKVM", 
        "HYPERV", 
        "RHELCONTAINER", 
        "RHELSERVER", 
        "UBUNTUSERVER", 
        "CENTOSSERVER", 
        "CENTOSKVM"
      ], 
      "required": false, 
      "title": "HostNode's Hypervisor type, for example ESXi, RHEL KVM or UBUNTU KVM.", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_address": {
      "required": false, 
      "title": "Management IP address of the node", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "HostNode", 
        "EdgeNode", 
        "PublicCloudGatewayNode"
      ], 
      "required": false, 
      "title": "Node type from 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node list parameters", 
  "type": "object"
}

NodeListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeListResult", 
  "module_id": "FabricNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Node"+
      }, 
      "required": true, 
      "title": "Node list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node list result", 
  "type": "object"
}

NodeLogProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeLogProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "Last modified time expressed in milliseconds since epoch"
    }, 
    "log_name": {
      "readonly": true, 
      "title": "Name of log file", 
      "type": "string"
    }, 
    "log_size": {
      "readonly": true, 
      "title": "Size of log file in bytes", 
      "type": "integer"
    }
  }, 
  "title": "Node log properties", 
  "type": "object"
}

NodeLogPropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeLogPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeLogProperties"+
      }, 
      "required": true, 
      "title": "Node log property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node log property query results", 
  "type": "object"
}

NodeMode (type) 

{
  "description": "Possible values of a mode in a \"/config/nsx_appliance_mode\" file", 
  "id": "NodeMode", 
  "properties": {
    "mode_id": {
      "description": "Possible enum values in a \"/config/nsx_appliance_mode\" file", 
      "enum": [
        "ON_PREM", 
        "SERVICE", 
        "VMC", 
        "VMC_LOCAL"
      ], 
      "required": true, 
      "title": "Nsx node mode", 
      "type": "string"
    }
  }, 
  "title": "Stub for Nsx node modes", 
  "type": "object"
}

NodeNameServersProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeNameServersProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "name_servers": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 3, 
      "required": true, 
      "title": "Name servers", 
      "type": "array"
    }
  }, 
  "title": "Node network name servers properties", 
  "type": "object"
}

NodeNetworkInterfaceProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeNetworkInterfaceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "admin_status": {
      "enum": [
        "up", 
        "down"
      ], 
      "readonly": true, 
      "title": "Interface administration status", 
      "type": "string"
    }, 
    "bond_mode": {
      "enum": [
        "ACTIVE_BACKUP", 
        "802_3AD"
      ], 
      "title": "Bond mode", 
      "type": "string"
    }, 
    "bond_primary": {
      "title": "Bond's primary device name in active-backup bond mode", 
      "type": "string"
    }, 
    "bond_slaves": {
      "items": {
        "type": "string"
      }, 
      "title": "Bond's slave devices", 
      "type": "array"
    }, 
    "broadcast_address": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface broadcast address", 
      "type": "string"
    }, 
    "default_gateway": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Interface's default gateway", 
      "type": "string"
    }, 
    "interface_id": {
      "readonly": true, 
      "required": true, 
      "title": "Interface ID", 
      "type": "string"
    }, 
    "ip_addresses": {
      "items": {
        "$ref": "IPv4AddressProperties"+
      }, 
      "maxItems": 1, 
      "title": "Interface IP addresses", 
      "type": "array"
    }, 
    "ip_configuration": {
      "enum": [
        "dhcp", 
        "static", 
        "not configured"
      ], 
      "required": true, 
      "title": "Interface configuration", 
      "type": "string"
    }, 
    "link_status": {
      "enum": [
        "up", 
        "down"
      ], 
      "readonly": true, 
      "title": "Interface administration status", 
      "type": "string"
    }, 
    "mtu": {
      "title": "Interface MTU", 
      "type": "integer"
    }, 
    "physical_address": {
      "pattern": "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$", 
      "readonly": true, 
      "title": "Interface MAC address", 
      "type": "string"
    }, 
    "plane": {
      "enum": [
        "mgmt", 
        "debug"
      ], 
      "title": "Interface plane", 
      "type": "string"
    }
  }, 
  "title": "Node network interface properties", 
  "type": "object"
}

NodeNetworkInterfacePropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeNetworkInterfacePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeNetworkInterfaceProperties"+
      }, 
      "required": true, 
      "title": "Node network interface property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node network interface properties list results", 
  "type": "object"
}

NodeNetworkProperties (type) 

{
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeNetworkProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }
  }, 
  "title": "Network configuration properties", 
  "type": "object"
}

NodeNtpServiceProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties"+
  }, 
  "id": "NodeNtpServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "NtpServiceProperties"+, 
      "title": "NTP Service properties"
    }
  }, 
  "title": "Node NTP service properties", 
  "type": "object"
}

NodeProcessProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeProcessProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cpu_time": {
      "readonly": true, 
      "title": "CPU time (user and system) consumed by process in milliseconds", 
      "type": "integer"
    }, 
    "mem_resident": {
      "readonly": true, 
      "title": "Resident set size of process in bytes", 
      "type": "integer"
    }, 
    "mem_used": {
      "readonly": true, 
      "title": "Virtual memory used by process in bytes", 
      "type": "integer"
    }, 
    "pid": {
      "readonly": true, 
      "title": "Process id", 
      "type": "integer"
    }, 
    "ppid": {
      "readonly": true, 
      "title": "Parent process id", 
      "type": "integer"
    }, 
    "process_name": {
      "readonly": true, 
      "title": "Process name", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "Process start time expressed in milliseconds since epoch"
    }, 
    "uptime": {
      "readonly": true, 
      "title": "Milliseconds since process started", 
      "type": "integer"
    }
  }, 
  "title": "Node process properties", 
  "type": "object"
}

NodeProcessPropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeProcessPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeProcessProperties"+
      }, 
      "required": true, 
      "title": "Node process property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node process property query results", 
  "type": "object"
}

NodeProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "bios_uuid": {
      "hidden": true, 
      "readonly": true, 
      "title": "Node BIOS Unique Indentifier", 
      "type": "string"
    }, 
    "cli_timeout": {
      "minimum": 0, 
      "title": "NSX CLI inactivity timeout, set to 0 to configure no timeout", 
      "type": "integer"
    }, 
    "export_type": {
      "enum": [
        "RESTRICTED", 
        "UNRESTRICTED"
      ], 
      "readonly": true, 
      "title": "Export restrictions in effect, if any", 
      "type": "string"
    }, 
    "hostname": {
      "$ref": "SystemHostname"+, 
      "title": "Host name or fully qualified domain name of node", 
      "type": "string"
    }, 
    "kernel_version": {
      "readonly": true, 
      "title": "Kernel version", 
      "type": "string"
    }, 
    "motd": {
      "title": "Message of the day to display when users login to node using the NSX CLI", 
      "type": [
        "string", 
        "null"
      ]
    }, 
    "node_uuid": {
      "hidden": true, 
      "maxLength": 36, 
      "title": "Node Unique Identifier", 
      "type": "string"
    }, 
    "node_version": {
      "readonly": true, 
      "title": "Node version", 
      "type": "string"
    }, 
    "product_version": {
      "readonly": true, 
      "title": "Product version", 
      "type": "string"
    }, 
    "system_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "Current time expressed in milliseconds since epoch"
    }, 
    "timezone": {
      "title": "Timezone", 
      "type": "string"
    }
  }, 
  "title": "Node properties", 
  "type": "object"
}

NodeProtonServiceProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties"+
  }, 
  "id": "NodeProtonServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "ProtonServiceProperties"+, 
      "title": "Service properties"
    }
  }, 
  "title": "Node service properties", 
  "type": "object"
}

NodeRouteProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeRouteProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "destination": {
      "title": "Destination covered by route", 
      "type": "string"
    }, 
    "from_address": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "From address", 
      "type": "string"
    }, 
    "gateway": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Address of next hop", 
      "type": "string"
    }, 
    "interface_id": {
      "title": "Network interface id of route", 
      "type": "string"
    }, 
    "metric": {
      "title": "Metric value of route", 
      "type": "string"
    }, 
    "netmask": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Netmask of destination covered by route", 
      "type": "string"
    }, 
    "proto": {
      "default": "boot", 
      "enum": [
        "unspec", 
        "redirect", 
        "kernel", 
        "boot", 
        "static", 
        "gated", 
        "ra", 
        "mrt", 
        "zebra", 
        "bird", 
        "dnrouted", 
        "xorp", 
        "ntk", 
        "dhcp"
      ], 
      "title": "Routing protocol identifier of route", 
      "type": "string"
    }, 
    "route_id": {
      "readonly": true, 
      "title": "Unique identifier for the route", 
      "type": "string"
    }, 
    "route_type": {
      "enum": [
        "default", 
        "static", 
        "blackhole", 
        "prohibit", 
        "throw", 
        "unreachable"
      ], 
      "required": true, 
      "title": "Route type", 
      "type": "string"
    }, 
    "scope": {
      "title": "Scope of destinations covered by route", 
      "type": "string"
    }, 
    "src": {
      "pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$", 
      "title": "Source address to prefer when sending to destinations of route", 
      "type": "string"
    }
  }, 
  "title": "Node network route properties", 
  "type": "object"
}

NodeRoutePropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeRoutePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeRouteProperties"+
      }, 
      "required": true, 
      "title": "Node route property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node network route properties list results", 
  "type": "object"
}

NodeSearchDomainsProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeSearchDomainsProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "search_domains": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Search domains", 
      "type": "array"
    }
  }, 
  "title": "Node network search domains properties", 
  "type": "object"
}

NodeServiceProperties (type) 

{
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }
  }, 
  "title": "Node service properties", 
  "type": "object"
}

NodeServicePropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeServicePropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeServiceProperties"+
      }, 
      "required": true, 
      "title": "Node service property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node service property query results", 
  "type": "object"
}

NodeServiceStatusProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeServiceStatusProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "monitor_pid": {
      "readonly": true, 
      "title": "Service monitor process id", 
      "type": "integer"
    }, 
    "monitor_runtime_state": {
      "enum": [
        "running", 
        "stopped"
      ], 
      "readonly": true, 
      "title": "Service monitor runtime state", 
      "type": "string"
    }, 
    "pids": {
      "items": {
        "type": "integer"
      }, 
      "readonly": true, 
      "title": "Service process ids", 
      "type": "array"
    }, 
    "runtime_state": {
      "enum": [
        "running", 
        "stopped"
      ], 
      "readonly": true, 
      "title": "Service runtime state", 
      "type": "string"
    }
  }, 
  "title": "Node service status properties", 
  "type": "object"
}

NodeSnmpServiceProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties"+
  }, 
  "id": "NodeSnmpServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "SnmpServiceProperties"+, 
      "required": true, 
      "title": "SNMP Service properties"
    }
  }, 
  "title": "Node SNMP service properties", 
  "type": "object"
}

NodeSshServiceProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NodeServiceProperties"+
  }, 
  "id": "NodeSshServiceProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "SshServiceProperties"+, 
      "title": "SSH Service properties"
    }
  }, 
  "title": "Node SSH service properties", 
  "type": "object"
}

NodeStatus (type) 

{
  "id": "NodeStatus", 
  "module_id": "FabricNode", 
  "properties": {
    "external_id": {
      "required": false, 
      "title": "HostNode external id", 
      "type": "string"
    }, 
    "host_node_deployment_status": {
      "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.\n", 
      "enum": [
        "NOT_PREPARED", 
        "INSTALL_IN_PROGRESS", 
        "INSTALL_FAILED", 
        "INSTALL_SUCCESSFUL", 
        "UNINSTALL_IN_PROGRESS", 
        "UNINSTALL_FAILED", 
        "UNINSTALL_SUCCESSFUL", 
        "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"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Install/Uninstall status of deployment.", 
      "type": "string"
    }, 
    "inventory_sync_paused": {
      "readonly": true, 
      "required": false, 
      "title": "Is true if inventory sync is paused else false", 
      "type": "boolean"
    }, 
    "inventory_sync_reenable_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": false, 
      "title": "Inventory sync auto re-enable target time, in epoch milis"
    }, 
    "last_heartbeat_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp of the last heartbeat status change, in epoch milliseconds."
    }, 
    "last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp of the last successful update of Inventory, in epoch milliseconds."
    }, 
    "lcp_connectivity_status": {
      "default": "UNKNOWN", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Indicates the fabric node's LCP<->CCP channel connectivity status, UP, DOWN, DEGRADED, UNKNOWN.", 
      "type": "string"
    }, 
    "lcp_connectivity_status_details": {
      "default": [], 
      "items": {
        "$ref": "ControlConnStatus"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Details, if any, about the current LCP<->CCP channel connectivity status of the fabric node.", 
      "type": "array"
    }, 
    "maintenance_mode": {
      "enum": [
        "OFF", 
        "ENTERING", 
        "ON", 
        "EXITING"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Indicates the fabric node's status of maintenance mode, OFF, ENTERING, ON, EXITING.", 
      "type": "string"
    }, 
    "mpa_connectivity_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Indicates the fabric node's MP<->MPA channel connectivity status, UP, DOWN, UNKNOWN.", 
      "type": "string"
    }, 
    "mpa_connectivity_status_details": {
      "readonly": true, 
      "required": false, 
      "title": "Details, if any, about the current MP<->MPA channel connectivity status of the fabric node.", 
      "type": "string"
    }, 
    "software_version": {
      "readonly": true, 
      "title": "Software version of the fabric node.", 
      "type": "string"
    }, 
    "system_status": {
      "$ref": "NodeStatusProperties"+, 
      "readonly": true, 
      "required": false, 
      "title": "Node status properties"
    }
  }, 
  "title": "Runtime status information of the fabric node.", 
  "type": "object"
}

NodeStatusProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeStatusProperties", 
  "module_id": "ApplianceStats", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cpu_cores": {
      "readonly": true, 
      "title": "Number of CPU cores on the system", 
      "type": "integer"
    }, 
    "file_systems": {
      "items": {
        "$ref": "NodeFileSystemProperties"+
      }, 
      "readonly": true, 
      "title": "File systems configured on the system", 
      "type": "array"
    }, 
    "load_average": {
      "items": {
        "type": "number"
      }, 
      "readonly": true, 
      "title": "One, five, and fifteen minute load averages for the system", 
      "type": "array"
    }, 
    "mem_cache": {
      "readonly": true, 
      "title": "Amount of RAM on the system that can be flushed out to disk, in kilobytes", 
      "type": "integer"
    }, 
    "mem_total": {
      "readonly": true, 
      "title": "Amount of RAM allocated to the system, in kilobytes", 
      "type": "integer"
    }, 
    "mem_used": {
      "readonly": true, 
      "title": "Amount of RAM in use on the system, in kilobytes", 
      "type": "integer"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "readonly": true, 
      "title": "Source of status data."
    }, 
    "swap_total": {
      "readonly": true, 
      "title": "Amount of disk available for swap, in kilobytes", 
      "type": "integer"
    }, 
    "swap_used": {
      "readonly": true, 
      "title": "Amount of swap disk in use, in kilobytes", 
      "type": "integer"
    }, 
    "system_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "title": "Current time expressed in milliseconds since epoch"
    }, 
    "uptime": {
      "readonly": true, 
      "title": "Milliseconds since system start", 
      "type": "integer"
    }
  }, 
  "title": "Node status properties", 
  "type": "object"
}

NodeSummary (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeSummary", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "component_version": {
      "readonly": true, 
      "required": true, 
      "title": "Component version", 
      "type": "string"
    }, 
    "node_count": {
      "description": "Number of nodes of the type and at the component version", 
      "readonly": true, 
      "required": true, 
      "title": "Count of nodes", 
      "type": "int"
    }, 
    "type": {
      "readonly": true, 
      "required": true, 
      "title": "Node type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeSummaryList (type) 

{
  "additionalProperties": false, 
  "id": "NodeSummaryList", 
  "module_id": "Upgrade", 
  "properties": {
    "results": {
      "items": {
        "$ref": "NodeSummary"+
      }, 
      "required": true, 
      "title": "List of Node Summary", 
      "type": "array"
    }
  }, 
  "type": "object"
}

NodeSyslogExporterProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeSyslogExporterProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "exporter_name": {
      "required": true, 
      "title": "Syslog exporter name", 
      "type": "string"
    }, 
    "facilities": {
      "items": {
        "$ref": "SyslogFacility"+
      }, 
      "title": "Facilities to export", 
      "type": "array"
    }, 
    "level": {
      "enum": [
        "EMERG", 
        "ALERT", 
        "CRIT", 
        "ERR", 
        "WARNING", 
        "NOTICE", 
        "INFO", 
        "DEBUG"
      ], 
      "required": true, 
      "title": "Logging level to export", 
      "type": "string"
    }, 
    "msgids": {
      "items": {
        "pattern": "^.+$", 
        "type": "string"
      }, 
      "title": "MSGIDs to export", 
      "type": "array"
    }, 
    "port": {
      "default": 514, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Port to export to", 
      "type": "integer"
    }, 
    "protocol": {
      "enum": [
        "TCP", 
        "TLS", 
        "UDP", 
        "LI", 
        "LI-TLS"
      ], 
      "required": true, 
      "title": "Export protocol", 
      "type": "string"
    }, 
    "server": {
      "$ref": "HostnameOrIPv4Address"+, 
      "required": true, 
      "title": "IP address or hostname of server to export to", 
      "type": "string"
    }, 
    "structured_data": {
      "items": {
        "pattern": "^(comp|subcomp|s2comp|security|audit|reqId|ereqId|entId|errorCode|eventId|euser|threadId|splitId|splitIndex)=.+$", 
        "type": "string"
      }, 
      "title": "Structured data to export", 
      "type": "array"
    }, 
    "tls_ca_pem": {
      "title": "CA certificate PEM of TLS server to export to", 
      "type": "string"
    }
  }, 
  "title": "Node syslog exporter properties", 
  "type": "object"
}

NodeSyslogExporterPropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeSyslogExporterPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeSyslogExporterProperties"+
      }, 
      "required": true, 
      "title": "Node syslog exporter results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node syslog exporter list results", 
  "type": "object"
}

NodeUserProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeUserProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "full_name": {
      "title": "Full name for the user", 
      "type": "string"
    }, 
    "old_password": {
      "sensitive": true, 
      "title": "Old password for the user (required on PUT if password specified)", 
      "type": "string"
    }, 
    "password": {
      "sensitive": true, 
      "title": "Password for the user (optionally specified on PUT, unspecified on GET)", 
      "type": "string"
    }, 
    "userid": {
      "maximum": 2147483647, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Numeric id for the user", 
      "type": "integer"
    }, 
    "username": {
      "maxLength": 32, 
      "minLength": 1, 
      "pattern": "^[a-zA-Z][a-zA-Z0-9@-_.\\-]*$", 
      "title": "User login name (must be \"root\" if userid is 0)", 
      "type": "string"
    }
  }, 
  "title": "Node user properties", 
  "type": "object"
}

NodeUserPropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NodeUserPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NodeUserProperties"+
      }, 
      "required": true, 
      "title": "List of node users", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node users list results", 
  "type": "object"
}

NodeUserSettings (type) 

{
  "additionalProperties": false, 
  "id": "NodeUserSettings", 
  "module_id": "FabricNode", 
  "properties": {
    "audit_password": {
      "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 8 characters in length and must\ncontain at least one lowercase, one uppercase, one numeric character and one\nspecial character (except quotes).\n", 
      "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[~`!@#$%^&*)(\\-_\\+\\=}{\\]\\[|:;,?\\.><])[A-Za-z\\d~`!@#$%^&*)(\\-_\\+\\=}{\\]\\[\\|:;,?\\.><]{8,}$", 
      "required": false, 
      "sensitive": true, 
      "title": "Node audit user password", 
      "type": "string"
    }, 
    "audit_username": {
      "description": "The default username is \"audit\". To configure username, you must provide\nthis property together with <b>audit_password</b>.\n", 
      "required": false, 
      "title": "CLI \"audit\" username", 
      "type": "string"
    }, 
    "cli_password": {
      "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 8 characters in length and must\ncontain at least one lowercase, one uppercase, one numeric character and one\nspecial character (except quotes).\n", 
      "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[~`!@#$%^&*)(\\-_\\+\\=}{\\]\\[|:;,?\\.><])[A-Za-z\\d~`!@#$%^&*)(\\-_\\+\\=}{\\]\\[\\|:;,?\\.><]{8,}$", 
      "required": false, 
      "sensitive": true, 
      "title": "Node cli password", 
      "type": "string"
    }, 
    "cli_username": {
      "default": "admin", 
      "description": "To configure username, you must provide this property together with\n<b>cli_password</b>.\n", 
      "required": false, 
      "title": "CLI \"admin\" username", 
      "type": "string"
    }, 
    "root_password": {
      "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 8 characters in length and must\ncontain at least one lowercase, one uppercase, one numeric character and one\nspecial character (except quotes).\n", 
      "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[~`!@#$%^&*)(\\-_\\+\\=}{\\]\\[|:;,?\\.><])[A-Za-z\\d~`!@#$%^&*)(\\-_\\+\\=}{\\]\\[\\|:;,?\\.><]{8,}$", 
      "required": false, 
      "sensitive": true, 
      "title": "Node root user password", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NodeVersion (type) 

{
  "additionalProperties": false, 
  "id": "NodeVersion", 
  "properties": {
    "node_version": {
      "readonly": true, 
      "title": "Node version", 
      "type": "string"
    }, 
    "product_version": {
      "readonly": true, 
      "title": "Product version", 
      "type": "string"
    }
  }, 
  "type": "object"
}

NormalizationListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "NormalizationListRequestParameters", 
  "module_id": "Normalization", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "preferred_normalization_type": {
      "$ref": "NormalizationTargetType"+, 
      "description": "Type to which the resource needs to be normalized. Multiple types\ncan be passed by repeating the parameter. The order in which the\ntypes are passed is honored and decides to which type the resource is\nnormalized. The resource is normalized to the first type in the list\nto which it can be normalized.\n\nFor example, consider an NSGroup NS1 that has an LSwitch LS1. Assume\nthat NS1 is being normalized to a list of translated entities\n[LSwitch, LPort]. As LSwitch is the first translated entity to which\nNSGroup can be translated, the translation will return a list having\nthe LSwitch LS1.\n\nNormalization is supported from NSGroup to NSGroup, LogicalSwitch,\nLogicalPort, IPSets and MACSets.\n", 
      "required": true, 
      "title": "Type to which the resource is to be normalized."
    }, 
    "resource_id": {
      "required": true, 
      "title": "Identifier of the resource on which normalization is to be performed", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "NormalizationSourceType"+, 
      "required": true, 
      "title": "Type of the resource for which normalization is to be performed"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Normalization list request parameters.", 
  "type": "object"
}

NormalizationSourceType (type) 

{
  "enum": [
    "NSGroup"
  ], 
  "id": "NormalizationSourceType", 
  "module_id": "Normalization", 
  "title": "Resource type valid for use as source in normalization API.", 
  "type": "string"
}

NormalizationTargetType (type) 

{
  "enum": [
    "NSGroup", 
    "IPSet", 
    "MACSet", 
    "LogicalSwitch", 
    "LogicalPort", 
    "DirectoryGroup"
  ], 
  "id": "NormalizationTargetType", 
  "module_id": "Normalization", 
  "title": "Resource type valid for use as target in normalization API.", 
  "type": "string"
}

NormalizedResourceListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NormalizedResourceListResult", 
  "module_id": "Normalization", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "required": true, 
      "title": "Normalized resource list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of normalized resources", 
  "type": "object"
}

NsxManagerAccount (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "NsxManagerAccount", 
  "module_id": "NsxManagerAccounts", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "fqdn": {
      "format": "hostname-or-ip", 
      "required": false, 
      "title": "Fully Qualified Domain Name", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "Password of the NSX Manager Account", 
      "type": "string"
    }, 
    "private_ip": {
      "required": false, 
      "title": "Private IP Address of the NSX Manager Account", 
      "type": "string"
    }, 
    "public_ip": {
      "required": false, 
      "title": "Public IP Address of the NSX Manager Account", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "required": false, 
      "title": "Tenant ID of the NSX Manager account", 
      "type": "string"
    }, 
    "thumbprint": {
      "required": false, 
      "title": "Thumb print of the NSX Manager Account", 
      "type": "string"
    }, 
    "token": {
      "description": "This field can be used for using one time access token for Nsx Manager\nregistration.\n", 
      "required": false, 
      "sensitive": true, 
      "title": "One time access token for Nsx Manager registration", 
      "type": "string"
    }, 
    "username": {
      "required": true, 
      "title": "Username of the NSX Manager Account", 
      "type": "string"
    }
  }, 
  "title": "NSX Manager Account Structure", 
  "type": "object"
}

NsxManagerAccountsListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "NsxManagerAccountsListResult", 
  "module_id": "NsxManagerAccounts", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "NsxManagerAccount"+
      }, 
      "required": false, 
      "title": "NSX Manager Accounts list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "NSX Manager Accounts list", 
  "type": "object"
}

NsxRole (type) 

{
  "id": "NsxRole", 
  "module_id": "AAA", 
  "properties": {
    "permissions": {
      "deprecated": true, 
      "description": "Please use the /user-info/permissions api to get the permission that the user has on each feature.", 
      "items": {
        "enum": [
          "read-api", 
          "read-write-api", 
          "crud", 
          "read", 
          "execute", 
          "none"
        ], 
        "type": "string"
      }, 
      "required": false, 
      "title": "Permissions", 
      "type": "array"
    }, 
    "role": {
      "enum": [
        "read_only_api_users", 
        "read_write_api_users", 
        "enterprise_admin", 
        "auditor", 
        "network_engineer", 
        "network_op", 
        "security_engineer", 
        "security_op", 
        "lb_admin", 
        "lb_auditor", 
        "cloud_service_admin", 
        "cloud_service_auditor", 
        "site_reliability_engineer", 
        "site_reliability_auditor", 
        "cloud_admin", 
        "cloud_auditor"
      ], 
      "required": true, 
      "title": "Role name", 
      "type": "string"
    }
  }, 
  "title": "Role", 
  "type": "object"
}

NtpServiceProperties (type) 

{
  "additionalProperties": false, 
  "id": "NtpServiceProperties", 
  "properties": {
    "servers": {
      "items": {
        "$ref": "HostnameOrIPv4Address"+
      }, 
      "required": true, 
      "title": "NTP servers", 
      "type": "array"
    }
  }, 
  "title": "NTP Service properties", 
  "type": "object"
}

Oauth2Credentials (type) 

{
  "additionalProperties": false, 
  "id": "Oauth2Credentials", 
  "properties": {
    "client_id": {
      "description": "Client ID, that will be used for authentication in AWS environment,", 
      "required": true, 
      "title": "Client ID", 
      "type": "string"
    }, 
    "client_secret": {
      "description": "Client secret, that will be used for authentication in AWS environment. Can be some passphrase.", 
      "required": true, 
      "sensitive": true, 
      "title": "Client Secret", 
      "type": "string"
    }
  }, 
  "title": "Oauth2 Account Credentials", 
  "type": "object"
}

OrgInfo (type) 

{
  "additionalProperties": false, 
  "description": "Organization ID and role, predefined for a particular type of VMware support.", 
  "id": "OrgInfo", 
  "properties": {
    "org_id": {
      "description": "Organization ID, connected to a predefined role of a VMware support.", 
      "required": true, 
      "title": "Org ID", 
      "type": "string"
    }, 
    "org_role": {
      "description": "Predefined role of a VMware support.", 
      "required": true, 
      "title": "Org role", 
      "type": "string"
    }
  }, 
  "title": "Organization ID and role", 
  "type": "object"
}

OwnerResourceLink (type) 

{
  "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
  "extends": {
    "$ref": "ResourceLink"+
  }, 
  "id": "OwnerResourceLink", 
  "module_id": "Common", 
  "properties": {
    "action": {
      "readonly": true, 
      "title": "Optional action", 
      "type": "string"
    }, 
    "href": {
      "readonly": true, 
      "required": true, 
      "title": "Link to resource", 
      "type": "string"
    }, 
    "rel": {
      "description": "Custom relation type (follows RFC 5988 where appropriate definitions exist)", 
      "readonly": true, 
      "required": true, 
      "title": "Link relation type", 
      "type": "string"
    }
  }, 
  "title": "Link to this resource", 
  "type": "object"
}

PBRListRequestParameters (type) 

{
  "description": "Pagination and Filtering parameters to get only a subset of sections/rules.", 
  "extends": {
    "$ref": "DSListRequestParameters"+
  }, 
  "id": "PBRListRequestParameters", 
  "module_id": "ManagerNode", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type\n'FILTER' will ensure all criterias (sources, destinations, services,\nappliedtos) are matched. Type 'SEARCH' will match any of the given\ncriteria.\n", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter list of sections/rules", 
  "type": "object"
}

PBRRule (type) 

{
  "extends": {
    "$ref": "EmbeddedResource"+
  }, 
  "id": "PBRRule", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink"+, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "action": {
      "description": "Action enforced on the packets which matches the PBR rule.", 
      "enum": [
        "ROUTE_TO_UNDERLAY_NAT", 
        "ROUTE_TO_OVERLAY_NAT", 
        "ROUTE_TO_UNDERLAY", 
        "ROUTE_TO_OVERLAY"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Action", 
      "type": "string"
    }, 
    "applied_tos": {
      "description": "List of object where rule will be enforced. field overrides this one. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of the destinations. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Destination List", 
      "type": "array"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable rule. Disabled will only be persisted but never provisioned/realized.", 
      "readonly": false, 
      "required": false, 
      "title": "Rule enable/disable flag", 
      "type": "boolean"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the resource", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "User notes specific to the rule.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Notes", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "maxLength": 32, 
      "readonly": false, 
      "required": false, 
      "title": "Tag", 
      "type": "string"
    }, 
    "services": {
      "description": "List of the services. Null will be treated as any.", 
      "items": {
        "$ref": "PBRService"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Service List", 
      "type": "array"
    }, 
    "sources": {
      "description": "List of sources. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Source List", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PBRRuleListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PBRRuleListResult", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "PBR rule list result with pagination support.", 
      "items": {
        "$ref": "PBRRule"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "PBR rule list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PBRSection (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "PBRSection", 
  "module_id": "ManagerNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PBRSectionFilterParameters (type) 

{
  "description": "Pagination and Filtering parameters to get only a subset of sections.", 
  "extends": {
    "$ref": "DSListRequestParameters"+
  }, 
  "id": "PBRSectionFilterParameters", 
  "module_id": "ManagerNode", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "exclude_applied_to_type": {
      "$ref": "DSAppliedToType"+, 
      "description": "Used to filter out sections not having a specified AppliedTo target type. This parameter cannot be used along with include_applied_to_type parameter. Section filter only takes a single value for this param.", 
      "required": false, 
      "title": "Limit result to sections not having a specific AppliedTo type"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type\n'FILTER' will ensure all criterias (sources, destinations, services,\nappliedtos) are matched. Type 'SEARCH' will match any of the given\ncriteria.\n", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "include_applied_to_type": {
      "$ref": "DSAppliedToType"+, 
      "description": "Used to filter out results based on target type of a section's AppliedTo. Only sections with matching target type in its applied to will be returned. This parameter cannot be used along with exclude_applied_to_type parameter.Section filter only takes a single value for this param.", 
      "required": false, 
      "title": "Limit result to sections having a specific AppliedTo type"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter section from list of sections", 
  "type": "object"
}

PBRSectionListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PBRSectionListResult", 
  "module_id": "ManagerNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of the PBR sections.", 
      "items": {
        "$ref": "PBRSection"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Section list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PBRSectionRuleList (type) 

{
  "extends": {
    "$ref": "PBRSection"+
  }, 
  "id": "PBRSectionRuleList", 
  "module_id": "ManagerNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "rules": {
      "description": "List of PBR rules in the section.", 
      "items": {
        "$ref": "PBRRule"+
      }, 
      "maxItems": 1000, 
      "readonly": false, 
      "required": true, 
      "title": "List of the PBR rules", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PBRService (type) 

{
  "description": "Type to define services associated with every rule", 
  "extends": {
    "$ref": "DSService"+
  }, 
  "id": "PBRService", 
  "module_id": "ManagerNode", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "service": {
      "$ref": "NSServiceElement"+, 
      "description": "Distributed Service API accepts raw protocol and ports as part of NS service element\nin Distributed Service Rule that describes traffic corresponding to an NSService.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Distributed Service Network and Security Service element"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "title": "PBR Service element", 
  "type": "object"
}

PackageStore (type) 

{
  "additionalProperties": false, 
  "id": "PackageStore", 
  "module_id": "HostPrepServiceFabric", 
  "properties": {
    "bulletin_ids": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of bulletin ids", 
      "type": "array"
    }, 
    "package_url": {
      "required": true, 
      "title": "url of the package", 
      "type": "string"
    }
  }, 
  "title": "Contains package information", 
  "type": "object"
}

PacketAddressClassifier (type) 

{
  "description": "A packet is classified to have an address binding, if its address\nconfiguration matches with all user specified properties.\n", 
  "id": "PacketAddressClassifier", 
  "module_id": "Switching", 
  "properties": {
    "ip_address": {
      "$ref": "IPElement"+, 
      "required": false, 
      "title": "A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y"
    }, 
    "mac_address": {
      "$ref": "MACAddress"+, 
      "required": false, 
      "title": "A single MAC address"
    }, 
    "vlan": {
      "$ref": "VlanID"+, 
      "required": false
    }
  }, 
  "title": "Address classifications for a packet", 
  "type": "object"
}

PacketCaptureOption (type) 

{
  "additionalProperties": false, 
  "description": "The option is used to filter data on given node.", 
  "id": "PacketCaptureOption", 
  "module_id": "PacketCapture", 
  "properties": {
    "name": {
      "description": "The avaiable option names in the enum can be used to filter the capture data.", 
      "enum": [
        "ETHTYPE", 
        "MAC", 
        "SRCMAC", 
        "DSTMAC", 
        "VLAN", 
        "IP", 
        "SRCIP", 
        "DSTIP", 
        "IPPROTO", 
        "PORT", 
        "SRCPORT", 
        "DSTPORT", 
        "VNI"
      ], 
      "title": "Packet capture option name", 
      "type": "string"
    }, 
    "value": {
      "description": "Define the capture value according to the given capture option.", 
      "title": "Packet capture option value", 
      "type": "string"
    }
  }, 
  "title": "Packet capture option", 
  "type": "object"
}

PacketCaptureOptionList (type) 

{
  "additionalProperties": false, 
  "description": "List of packet capture options to filter data in capture process.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PacketCaptureOptionList", 
  "module_id": "PacketCapture", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "values": {
      "description": "Packet capture option collection", 
      "items": {
        "$ref": "PacketCaptureOption"+
      }, 
      "title": "Packet capture option collection", 
      "type": "array"
    }
  }, 
  "title": "List of packet capture options", 
  "type": "object"
}

PacketCaptureRequest (type) 

{
  "description": "This type is used to create packet request on give node. Need to specify related parameters according to the capture point.", 
  "id": "PacketCaptureRequest", 
  "module_id": "PacketCapture", 
  "properties": {
    "capamount": {
      "description": "Define the packet capture amount size.", 
      "title": "Packet capture amount", 
      "type": "int"
    }, 
    "capduration": {
      "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", 
      "type": "int"
    }, 
    "capfilesize": {
      "description": "Define the packet capture file size limit.", 
      "title": "Packet capture file size limit", 
      "type": "int"
    }, 
    "capmode": {
      "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.", 
      "enum": [
        "STANDALONE", 
        "STREAM"
      ], 
      "title": "Packet Capture streaming mode", 
      "type": "string"
    }, 
    "cappoint": {
      "description": "Define the point to capture data.", 
      "enum": [
        "VNIC", 
        "VMKNIC", 
        "VMNIC", 
        "VDRPORT", 
        "DVFILTER", 
        "LOGICALPORT", 
        "VIF"
      ], 
      "required": true, 
      "title": "Packet capture point", 
      "type": "string"
    }, 
    "caprate": {
      "description": "Define the rate of packet capture process.", 
      "title": "Packet capture rate", 
      "type": "int"
    }, 
    "capsource": {
      "description": "This type is used to differenite the incoming request from CLI/UI.", 
      "enum": [
        "CLI", 
        "UI"
      ], 
      "required": true, 
      "title": "Packet capture source type", 
      "type": "string"
    }, 
    "capvalue": {
      "description": "Define the capture value of given capture point.", 
      "title": "Packet capture point value", 
      "type": "string"
    }, 
    "direction": {
      "description": "Define the capture direction. Support three types INPUT/OUTPUT/DUAL.", 
      "enum": [
        "INPUT", 
        "OUTPUT", 
        "DUAL"
      ], 
      "title": "Packet capture direction type", 
      "type": "string"
    }, 
    "filtertype": {
      "description": "Define the capture filter type. Support PRE/POST mode.", 
      "enum": [
        "PRE", 
        "POST"
      ], 
      "title": "Packet capture dvfilter stage type", 
      "type": "string"
    }, 
    "node": {
      "description": "Define the transport node to capture data.", 
      "title": "Packet capture node id", 
      "type": "string"
    }, 
    "options": {
      "$ref": "PacketCaptureOptionList"+, 
      "description": "Define the packet capture additional options to filter the capture data.", 
      "title": "Packet capture options"
    }, 
    "streamaddress": {
      "description": "Set the stream address to receive the capture packet.", 
      "title": "Packet capture Streaming address", 
      "type": "string"
    }, 
    "streamport": {
      "description": "Set the stream port to receive the capture packet.", 
      "title": "Packet capture Streaming port", 
      "type": "int"
    }
  }, 
  "title": "Packet capture request information", 
  "type": "object"
}

PacketCaptureSession (type) 

{
  "additionalProperties": false, 
  "id": "PacketCaptureSession", 
  "module_id": "PacketCapture", 
  "properties": {
    "endtime": {
      "$ref": "EpochMsTimestamp"+, 
      "title": "Timestamp when session was stopped in epoch millisecond"
    }, 
    "errormsg": {
      "title": "Error messasge in capture", 
      "type": "string"
    }, 
    "filelocation": {
      "title": "Packet capture file location", 
      "type": "string"
    }, 
    "filesize": {
      "title": "Packet capture file Size in bytes", 
      "type": "int"
    }, 
    "request": {
      "$ref": "PacketCaptureRequest"+, 
      "required": true, 
      "title": "Packet capture request"
    }, 
    "sessionid": {
      "required": true, 
      "title": "Packet capture session id", 
      "type": "string"
    }, 
    "sessionname": {
      "title": "Packet capture session name", 
      "type": "string"
    }, 
    "sessionstatus": {
      "enum": [
        "CREATED", 
        "STARTED", 
        "STOPPED", 
        "FINISHED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Packet capture session status", 
      "type": "string"
    }, 
    "starttime": {
      "$ref": "EpochMsTimestamp"+, 
      "title": "Timestamp when session was created in epoch millisecond"
    }
  }, 
  "title": "Packet capture response information", 
  "type": "object"
}

PacketCaptureSessionList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PacketCaptureSessionList", 
  "module_id": "PacketCapture", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "required": true, 
      "title": "Total capture session count", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PacketCaptureSession"+
      }, 
      "title": "Packet capture list for all sessoins", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PasswordAuthenticationScheme (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AuthenticationScheme"+
  }, 
  "id": "PasswordAuthenticationScheme", 
  "properties": {
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "password"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "pattern": "^.+$", 
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "type": "object"
}

PemFile (type) 

{
  "additionalProperties": false, 
  "id": "PemFile", 
  "module_id": "CertificateManager", 
  "properties": {
    "file": {
      "required": true, 
      "title": "file data", 
      "type": "multipart_file"
    }
  }, 
  "type": "object"
}

PerStepRestoreStatus (type) 

{
  "id": "PerStepRestoreStatus", 
  "module_id": "ClusterRestore", 
  "properties": {
    "description": {
      "readonly": true, 
      "required": true, 
      "title": "A description of the restore status", 
      "type": "string"
    }, 
    "value": {
      "enum": [
        "INITIAL", 
        "RUNNING", 
        "SUSPENDED_BY_USER", 
        "SUSPENDED_FOR_USER_ACTION", 
        "FAILED", 
        "SUCCESS"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Per step restore status value", 
      "type": "string"
    }
  }, 
  "title": "Restore step status", 
  "type": "object"
}

PersistenceProfileType (type) 

{
  "additionalProperties": false, 
  "description": "Source-ip persistence ensures all connections from a client (identified by\nIP address) are sent to the same backend server for a specified period.\nCookie persistence allows related client connections, identified by the\nsame cookie in HTTP requests, to be redirected to the same server.\n", 
  "enum": [
    "LbCookiePersistenceProfile", 
    "LbSourceIpPersistenceProfile"
  ], 
  "id": "PersistenceProfileType", 
  "module_id": "LoadBalancer", 
  "title": "persistence profile type", 
  "type": "string"
}

Pnic (type) 

{
  "id": "Pnic", 
  "module_id": "TransportNode", 
  "properties": {
    "device_name": {
      "readonly": false, 
      "required": true, 
      "title": "device name or key", 
      "type": "string"
    }, 
    "uplink_name": {
      "readonly": false, 
      "required": true, 
      "title": "Uplink name for this Pnic. This name will be used to reference this Pnic in other configurations.", 
      "type": "string"
    }
  }, 
  "title": "Physical NIC specification", 
  "type": "object"
}

PnicBondStatus (type) 

{
  "additionalProperties": false, 
  "description": "pNIC/bond statuses", 
  "id": "PnicBondStatus", 
  "module_id": "Heatmap", 
  "properties": {
    "name": {
      "description": "Name of the pNIC/bond", 
      "title": "pNIC/bond name", 
      "type": "string"
    }, 
    "status": {
      "description": "Status of pNIC/bond", 
      "enum": [
        "UNKNOWN", 
        "UP", 
        "DOWN", 
        "DEGRADED"
      ], 
      "title": "pNic/bond status", 
      "type": "string"
    }, 
    "type": {
      "description": "type, whether the object is a pNIC or a bond", 
      "enum": [
        "UNKNOWN_TYPE", 
        "PNIC", 
        "BOND"
      ], 
      "title": "Object type", 
      "type": "string"
    }
  }, 
  "title": "pNIC/bond status", 
  "type": "object"
}

PnicBondStatusListResult (type) 

{
  "additionalProperties": false, 
  "description": "This object contains reference to list of pNIC/bond statuses", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PnicBondStatusListResult", 
  "module_id": "Heatmap", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of pNIC statuses belonging to the transport node", 
      "items": {
        "$ref": "PnicBondStatus"+
      }, 
      "title": "List of pNIC/bond statuses", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "pNIC status list container", 
  "type": "object"
}

PnicMirrorDestination (type) 

{
  "extends": {
    "$ref": "MirrorDestination"+
  }, 
  "id": "PnicMirrorDestination", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PnicMirrorDestination"
  }, 
  "properties": {
    "dest_pnics": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 3, 
      "minItems": 1, 
      "required": true, 
      "title": "Physical NIC device names to which to send the mirrored packets", 
      "type": "array"
    }, 
    "node_id": {
      "required": true, 
      "title": "Transport node to which to send the mirrored packets", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "MirrorDestinationResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorDestination'", 
      "required": true
    }
  }, 
  "type": "object"
}

PnicMirrorSource (type) 

{
  "extends": {
    "$ref": "MirrorSource"+
  }, 
  "id": "PnicMirrorSource", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PnicMirrorSource"
  }, 
  "properties": {
    "encapsulated": {
      "default": false, 
      "required": true, 
      "title": "Whether to filter encapsulated packet.", 
      "type": "boolean"
    }, 
    "node_id": {
      "required": true, 
      "title": "Transport node identifier for the pnic located.", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "MirrorSourceResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorSource', 'PnicMirrorSource'", 
      "required": true
    }, 
    "source_pnics": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Source physical NIC device names", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PolicyBasedIPSecVPNSession (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "IPSecVPNSession"+
  }, 
  "id": "PolicyBasedIPSecVPNSession", 
  "module_id": "IPSecVPN", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PolicyBasedIPSecVPNSession"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable/Disable IPSec VPN session.", 
      "title": "Enable/Disable IPSec VPN session", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipsec_vpn_service_id": {
      "description": "Identifier of VPN Service linked with local endpoint.", 
      "readonly": true, 
      "title": "IPSec VPN service identifier", 
      "type": "string"
    }, 
    "local_endpoint_id": {
      "description": "Local endpoint identifier.", 
      "required": true, 
      "title": "Local endpoint identifier", 
      "type": "string"
    }, 
    "peer_endpoint_id": {
      "description": "Peer endpoint identifier.", 
      "required": true, 
      "title": "Peer endpoint identifier", 
      "type": "string"
    }, 
    "policy_rules": {
      "items": {
        "$ref": "IPSecVPNPolicyRule"+
      }, 
      "required": true, 
      "title": "Policy rules", 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "IPSecVPNSessionResourceType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Policy based VPN session", 
  "type": "object"
}

PoolAlgorithm (type) 

{
  "additionalProperties": false, 
  "description": "Load Balancing algorithm chooses a server for each new connection by going\nthrough the list of servers in the pool. Currently, following load balancing\nalgorithms are supported with ROUND_ROBIN as the default.\nROUND_ROBIN means that a server is selected in a round-robin fashion. The\nweight would be ignored even if it is configured.\nWEIGHTED_ROUND_ROBIN means that a server is selected in a weighted\nround-robin fashion. Default weight of 1 is used if weight is not configured.\nLEAST_CONNECTION means that a server is selected when it has the least\nnumber of connections. The weight would be ignored even if it is configured.\nSlow start would be enabled by default.\nWEIGHTED_LEAST_CONNECTION means that a server is selected in a weighted\nleast connection fashion. Default weight of 1 is used if weight is not\nconfigured. Slow start would be enabled by default.\nIP_HASH means that consistent hash is performed on the source IP address of\nthe incoming connection. This ensures that the same client IP address will\nalways reach the same server as long as no server goes down or up. It may\nbe used on the Internet to provide a best-effort stickiness to clients\nwhich refuse session cookies.\n", 
  "enum": [
    "ROUND_ROBIN", 
    "WEIGHTED_ROUND_ROBIN", 
    "LEAST_CONNECTION", 
    "WEIGHTED_LEAST_CONNECTION", 
    "IP_HASH"
  ], 
  "id": "PoolAlgorithm", 
  "module_id": "LoadBalancer", 
  "title": "load balancing algorithm", 
  "type": "string"
}

PoolMember (type) 

{
  "additionalProperties": false, 
  "id": "PoolMember", 
  "module_id": "LoadBalancer", 
  "properties": {
    "admin_state": {
      "$ref": "PoolMemberAdminStateType"+, 
      "default": "ENABLED", 
      "required": false, 
      "title": "member admin state"
    }, 
    "backup_member": {
      "default": false, 
      "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", 
      "required": false, 
      "title": "determine whether the pool member is for backup usage", 
      "type": "boolean"
    }, 
    "display_name": {
      "required": false, 
      "title": "pool member name", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "pool member IP address"
    }, 
    "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", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "maximum concurrent connection number", 
      "type": "integer"
    }, 
    "port": {
      "$ref": "PortElement"+, 
      "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", 
      "required": false, 
      "title": "pool member port number"
    }, 
    "weight": {
      "default": 1, 
      "description": "Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing\nalgorithm. The weight value would be ignored in other algorithms.\n", 
      "maximum": 256, 
      "minimum": 1, 
      "required": false, 
      "title": "pool member weight", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

PoolMemberAdminStateType (type) 

{
  "additionalProperties": false, 
  "description": "User can set the admin state of a member to ENABLED or DISABLED or\nGRACEFUL_DISABLED. By default, when a member is added, it is ENABLED.\nIf a member is set to DISABLED, it is not selected for any new\nconnections. Active connections, however, will continue to be processed\nby it. New connections with matching persistence entries pointing to\nDISABLED members are not sent to those DISABLED members. Those connections\nare assigned to other members of the pool and the corresponding persistence\nentries are updated to point to the newly selected server.\nTo allow for a more graceful way of taking down servers for maintenance, a\nroutine task, another admin state GRACEFUL_DISABLED is supported. Existing\nconnections to a member in GRACEFUL_DISABLED state continue to be processed.\n", 
  "enum": [
    "ENABLED", 
    "DISABLED", 
    "GRACEFUL_DISABLED"
  ], 
  "id": "PoolMemberAdminStateType", 
  "module_id": "LoadBalancer", 
  "title": "pool member admin state", 
  "type": "string"
}

PoolMemberGroup (type) 

{
  "additionalProperties": false, 
  "id": "PoolMemberGroup", 
  "module_id": "LoadBalancer", 
  "properties": {
    "customized_members": {
      "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", 
      "items": {
        "$ref": "PoolMemberSetting"+
      }, 
      "readonly": false, 
      "title": "List of customized pool member settings", 
      "type": "array"
    }, 
    "grouping_object": {
      "$ref": "ResourceReference"+, 
      "description": "Load balancer pool support grouping object as dynamic pool members.\nThe IP list of the grouping object such as NSGroup would be used as\npool member IP setting.\n", 
      "required": true, 
      "title": "Grouping object resource reference"
    }, 
    "ip_revision_filter": {
      "default": "IPV4", 
      "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", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "required": false, 
      "title": "Filter of ipv4 or ipv6 address of grouping object IP list", 
      "type": "string"
    }, 
    "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", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "required": false, 
      "title": "Maximum number of grouping object IP address list", 
      "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", 
      "maximum": 65535, 
      "minimum": 1, 
      "required": false, 
      "title": "Pool member port for all IP addresses of the grouping object", 
      "type": "int"
    }
  }, 
  "type": "object"
}

PoolMemberSetting (type) 

{
  "additionalProperties": false, 
  "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", 
  "id": "PoolMemberSetting", 
  "module_id": "LoadBalancer", 
  "properties": {
    "admin_state": {
      "$ref": "PoolMemberAdminStateType"+, 
      "default": "ENABLED", 
      "required": false, 
      "title": "Member admin state"
    }, 
    "display_name": {
      "description": "Only applicable to static pool members. If supplied for a pool defined\nby a grouping object, update API would fail.\n", 
      "required": false, 
      "title": "Pool member display name", 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": true, 
      "title": "Pool member IP address"
    }, 
    "port": {
      "$ref": "PortElement"+, 
      "required": false, 
      "title": "Pool member port number"
    }, 
    "weight": {
      "description": "Only applicable to static pool members. If supplied for a pool defined\nby a grouping object, update API would fail.\n", 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "Pool member weight", 
      "type": "integer"
    }
  }, 
  "title": "Pool member setting", 
  "type": "object"
}

PoolUsage (type) 

{
  "additionalProperties": false, 
  "description": "Pool usage statistics in a pool.", 
  "id": "PoolUsage", 
  "module_id": "Ipam", 
  "properties": {
    "allocated_ids": {
      "readonly": true, 
      "title": "Total number of allocated IDs in a pool", 
      "type": "integer"
    }, 
    "free_ids": {
      "readonly": true, 
      "title": "Total number of free IDs in a pool", 
      "type": "integer"
    }, 
    "total_ids": {
      "readonly": true, 
      "title": "Total number of IDs in a pool", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

PortElement (type) 

{
  "description": "Examples- Single port \"8080\", Range of ports \"8090-8095\"\n", 
  "format": "port-or-range", 
  "id": "PortElement", 
  "module_id": "Common", 
  "title": "A port or a port range", 
  "type": "string"
}

PortMirroringSession (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "PortMirroringSession", 
  "module_id": "PortMirroring", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "direction": {
      "$ref": "DirectionType"+, 
      "required": true, 
      "title": "Port mirroring session direction"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "encapsulation_vlan_id": {
      "$ref": "VlanID"+, 
      "description": "Only for Remote SPAN Port Mirror.", 
      "required": false, 
      "title": "Encapsulation VLAN ID"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mirror_destination": {
      "$ref": "MirrorDestination"+, 
      "required": true, 
      "title": "Mirror destination"
    }, 
    "mirror_sources": {
      "items": {
        "$ref": "MirrorSource"+
      }, 
      "maxItems": 6, 
      "minItems": 1, 
      "required": true, 
      "title": "Mirror sources", 
      "type": "array"
    }, 
    "preserve_original_vlan": {
      "default": false, 
      "required": false, 
      "title": "Only for Remote SPAN Port Mirror. Whether to preserve original VLAN.", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "session_type": {
      "$ref": "PortMirroringSessionType"+, 
      "default": "LocalPortMirrorSession", 
      "description": "If this property is unset, this session will be treated as\nLocalPortMirrorSession.\n", 
      "required": false, 
      "title": "Port mirroring session type"
    }, 
    "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", 
      "maximum": 65535, 
      "minimum": 60, 
      "required": false, 
      "title": "Maximum packet length for packet truncation", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PortMirroringSessionListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PortMirroringSessionListResult", 
  "module_id": "PortMirroring", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "PortMirroringSession"+
      }, 
      "readonly": true, 
      "title": "Port mirroring session results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Mirror session queries result", 
  "type": "object"
}

PortMirroringSessionType (type) 

{
  "additionalProperties": false, 
  "description": "PortMirroringSession is the configuration instance of port mirroring, you can\ncreate different types of PortMirroringSession with different mirror source\nand mirror destination.\nEach port mirror session type has its own mirror source and mirror destination pair.\nLocalPortMirrorSession include LogicalPortMirrorSession and UplinkPortMirrorSession.\nYou can create multiple mirror sessions of same parent type by one API call.\nLogicalPortMirrorSession\n  - source[LogicalPortMirrorSource] destination[LogicalPortMirrorDestination]\nUplinkPortMirrorSession\n  - source[PnicMirrorSource] destination[LogicalPortMirrorDestination]\nRspanSrcMirrorSession\n  - source[LogicalPortMirrorSource] destination[PnicMirrorDestination]\nRspanDstMirrorSession\n  - source[VlanMirrorSource] destination[LogicalPortMirrorDestination]\nLogicalLocalPortMirrorSession\n  - source[LogicalPortMirrorSource] destination[LogicalPortMirrorDestination]\nL3PortMirrorSession\n  - source[LogicalPortMirrorSource] destination[IPMirrorDestination]\n", 
  "enum": [
    "LogicalPortMirrorSession", 
    "UplinkPortMirrorSession", 
    "RspanSrcMirrorSession", 
    "RspanDstMirrorSession", 
    "LocalPortMirrorSession", 
    "LogicalLocalPortMirrorSession", 
    "L3PortMirrorSession"
  ], 
  "id": "PortMirroringSessionType", 
  "module_id": "PortMirroring", 
  "title": "Resource types of mirror session", 
  "type": "string"
}

PortMirroringSwitchingProfile (type) 

{
  "extends": {
    "$ref": "BaseSwitchingProfile"+
  }, 
  "id": "PortMirroringSwitchingProfile", 
  "module_id": "PortMirroringSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PortMirroringSwitchingProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "maxItems": 3, 
      "title": "List of destination addresses", 
      "type": "array"
    }, 
    "direction": {
      "$ref": "DirectionType"+
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key": {
      "required": false, 
      "title": "User-configurable 32-bit key", 
      "type": "integer"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n", 
      "required": true, 
      "type": "string"
    }, 
    "snap_length": {
      "description": "If this property not set, original package will not be truncated.", 
      "maximum": 65535, 
      "minimum": 60, 
      "required": false, 
      "title": "Snap length for package truncation", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PortStatus (type) 

{
  "additionalProperties": false, 
  "id": "PortStatus", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "indicates if the RabbitMQ management port is set or not", 
      "type": "boolean"
    }
  }, 
  "title": "indicates if the RabbitMQ management port is set or not", 
  "type": "object"
}

PreconfiguredEndpoint (type) 

{
  "id": "PreconfiguredEndpoint", 
  "module_id": "TransportNode", 
  "properties": {
    "device_name": {
      "readonly": false, 
      "required": true, 
      "title": "Name of the virtual tunnel endpoint", 
      "type": "string"
    }
  }, 
  "title": "Tunnel endpoint configuration of preconfigured host switch", 
  "type": "object"
}

PreconfiguredHostSwitch (type) 

{
  "description": "Preconfigured host switch is used for manually configured transport node.", 
  "id": "PreconfiguredHostSwitch", 
  "module_id": "TransportNode", 
  "properties": {
    "endpoints": {
      "items": {
        "$ref": "PreconfiguredEndpoint"+
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "List of virtual tunnel endpoints which are preconfigured on this host switch", 
      "type": "array"
    }, 
    "host_switch_id": {
      "readonly": false, 
      "required": true, 
      "title": "External Id of the preconfigured host switch.", 
      "type": "string"
    }
  }, 
  "title": "Preconfigured host switch", 
  "type": "object"
}

PreconfiguredHostSwitchSpec (type) 

{
  "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.", 
  "extends": {
    "$ref": "HostSwitchSpec"+
  }, 
  "id": "PreconfiguredHostSwitchSpec", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PreconfiguredHostSwitchSpec"
  }, 
  "properties": {
    "host_switches": {
      "items": {
        "$ref": "PreconfiguredHostSwitch"+
      }, 
      "maxItems": 1, 
      "required": true, 
      "title": "Preconfigured Transport Node host switches", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "StandardHostSwitchSpec", 
        "PreconfiguredHostSwitchSpec"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Specification of transport node preconfigured host switch", 
  "type": "object"
}

PrefixConfig (type) 

{
  "additionalProperties": false, 
  "id": "PrefixConfig", 
  "module_id": "Routing", 
  "properties": {
    "action": {
      "$ref": "RoutingFilterAction"+, 
      "required": true, 
      "title": "Action for the IPPrefix"
    }, 
    "ge": {
      "maximum": 32, 
      "minimum": 1, 
      "required": false, 
      "title": "Greater than or equal to", 
      "type": "integer"
    }, 
    "le": {
      "maximum": 32, 
      "minimum": 1, 
      "required": false, 
      "title": "Less than or equal to", 
      "type": "integer"
    }, 
    "network": {
      "$ref": "IPv4CIDRBlock"+, 
      "description": "If absent, the action applies to all addresses.", 
      "required": false, 
      "title": "CIDR"
    }
  }, 
  "type": "object"
}

Principal (type) 

{
  "additionalProperties": false, 
  "id": "Principal", 
  "module_id": "CertificateManager", 
  "properties": {
    "attributes": {
      "description": "Certificate list", 
      "items": {
        "$ref": "KeyValue"+
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }
  }, 
  "type": "object"
}

PrincipalIdentity (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "PrincipalIdentity", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "certificate_id": {
      "description": "Id of the stored certificate", 
      "readonly": false, 
      "required": true, 
      "title": "Id of the stored certificate", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_protected": {
      "description": "Indicator whether the entities created by this principal should be protected", 
      "readonly": false, 
      "required": false, 
      "title": "Protection indicator", 
      "type": "boolean"
    }, 
    "name": {
      "description": "Name of the principal", 
      "maxLength": 255, 
      "pattern": "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$", 
      "readonly": false, 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "node_id": {
      "description": "Unique node-id of a principal", 
      "maxLength": 255, 
      "pattern": "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$", 
      "readonly": false, 
      "required": true, 
      "title": "Unique node-id", 
      "type": "string"
    }, 
    "permission_group": {
      "$ref": "UserGroupType"+, 
      "deprecated": true, 
      "description": "Use the 'role' field instead and pass in 'auditor' for read_only_api_users or 'enterprise_admin' for the others.", 
      "readonly": false, 
      "required": false, 
      "title": "permission group"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "role": {
      "pattern": "^[a-zA-Z]+(_?[a-zA-Z]+)*$", 
      "readonly": false, 
      "required": false, 
      "title": "Role", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

PrincipalIdentityList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PrincipalIdentityList", 
  "module_id": "CertificateManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "PrincipalIdentity list", 
      "items": {
        "$ref": "PrincipalIdentity"+
      }, 
      "readonly": false, 
      "required": true, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "PrincipalIdentity query result", 
  "type": "object"
}

PropertyItem (type) 

{
  "additionalProperties": false, 
  "description": "Represents a label-value pair.", 
  "id": "PropertyItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "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.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "field": {
      "description": "Represents field value of the property.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Field of the Property", 
      "type": "string"
    }, 
    "heading": {
      "default": false, 
      "description": "Set to true if the field is a heading. Default is false.", 
      "title": "If true, represents the field as a heading", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label"+, 
      "description": "If a field represents a heading, then label is not needed", 
      "title": "Label of the property"
    }, 
    "render_configuration": {
      "description": "Render configuration to be applied, if any.", 
      "items": {
        "$ref": "RenderConfiguration"+
      }, 
      "title": "Render Configuration", 
      "type": "array"
    }, 
    "type": {
      "default": "String", 
      "description": "Data type of the field.", 
      "enum": [
        "String", 
        "Number", 
        "Date", 
        "Url"
      ], 
      "maxLength": 255, 
      "required": true, 
      "title": "field data type", 
      "type": "string"
    }
  }, 
  "title": "LabelValue Property", 
  "type": "object"
}

Protocol (type) 

{
  "abstract": true, 
  "additionalProperties": {}, 
  "id": "Protocol", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "name"
  }, 
  "properties": {
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ProtocolVersion (type) 

{
  "additionalProperties": false, 
  "id": "ProtocolVersion", 
  "properties": {
    "enabled": {
      "required": true, 
      "title": "Enable status for this protocol version", 
      "type": "boolean"
    }, 
    "name": {
      "required": true, 
      "title": "Name of the TLS protocol version", 
      "type": "string"
    }
  }, 
  "title": "HTTP protocol version", 
  "type": "object"
}

ProtonPackageLoggingLevels (type) 

{
  "additionalProperties": false, 
  "id": "ProtonPackageLoggingLevels", 
  "properties": {
    "logging_level": {
      "enum": [
        "ERROR", 
        "WARN", 
        "INFO", 
        "DEBUG", 
        "TRACE"
      ], 
      "title": "Logging levels per package", 
      "type": "string"
    }, 
    "package_name": {
      "title": "Package name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ProtonServiceProperties (type) 

{
  "additionalProperties": false, 
  "id": "ProtonServiceProperties", 
  "properties": {
    "logging_level": {
      "enum": [
        "ERROR", 
        "WARN", 
        "INFO", 
        "DEBUG", 
        "TRACE"
      ], 
      "required": true, 
      "title": "Service logging level", 
      "type": "string"
    }, 
    "package_logging_level": {
      "items": {
        "$ref": "ProtonPackageLoggingLevels"+
      }, 
      "title": "Package logging levels", 
      "type": "array"
    }
  }, 
  "title": "Service properties", 
  "type": "object"
}

ProxyServerProfileInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ProxyServerProfileInfo", 
  "module_id": "ProxyServerProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "host": {
      "description": "IP Address or name of the proxy server.\n", 
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "IP Address or name of the proxy server", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "default": false, 
      "description": "Flag which decides whether current proxy server profile\nis default or not.\n", 
      "required": false, 
      "title": "Flag to decide default proxy profile", 
      "type": "boolean"
    }, 
    "password": {
      "description": "The Password for the proxy server.\n", 
      "required": false, 
      "sensitive": true, 
      "title": "Password of the proxy server", 
      "type": "string"
    }, 
    "port": {
      "description": "The port of the proxy server.\n", 
      "required": true, 
      "title": "Port of the proxy server", 
      "type": "integer"
    }, 
    "profilename": {
      "description": "The name of proxy profile.\n", 
      "required": true, 
      "title": "Name of the proxy profile", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tls_certificate": {
      "description": "If proxy server is using TLS certificate for secure\ncommunication. In that case, certificate of Proxy Server\nis required.\n", 
      "required": false, 
      "title": "TLS certificate of Proxy Server", 
      "type": "string"
    }, 
    "username": {
      "description": "The username for the proxy server.\n", 
      "required": false, 
      "title": "Username of the proxy server", 
      "type": "string"
    }
  }, 
  "title": "Proxy Server Profile Information", 
  "type": "object"
}

ProxyServerProfilesListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ProxyServerProfilesListResult", 
  "module_id": "ProxyServerProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ProxyServerProfileInfo"+
      }, 
      "required": false, 
      "title": "Proxy Server Profile list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Proxy Server Profiles list", 
  "type": "object"
}

PublicCloudGatewayNode (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "EdgeNode"+
  }, 
  "id": "PublicCloudGatewayNode", 
  "module_id": "FabricNode", 
  "nsx_feature": "PublicCloud", 
  "polymorphic-type-descriptor": {
    "type-identifier": "PublicCloudGatewayNode"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "allocation_list": {
      "description": "List of logical router ids to which this edge node is allocated.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Allocation list", 
      "type": "array"
    }, 
    "deployment_config": {
      "$ref": "EdgeNodeDeploymentConfig"+, 
      "description": "When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE\nwill be deployed and registered with MP.\n", 
      "required": false, 
      "title": "Config for automatic deployment of edge node virtual machine."
    }, 
    "deployment_type": {
      "$ref": "EdgeDeploymentType"+, 
      "readonly": true, 
      "required": false
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "discovered_ip_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Discovered IP Addresses of the fabric node, version 4 or 6", 
      "type": "array"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "ID of the Node maintained on the Node and used to recognize the Node", 
      "type": "string"
    }, 
    "fqdn": {
      "readonly": true, 
      "required": false, 
      "title": "Fully qualified domain name of the fabric node", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ip_addresses": {
      "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", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": false, 
      "title": "IP Addresses of the Node, version 4 or 6", 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'HostNode', 'EdgeNode', 'PublicCloudGatewayNode'", 
      "required": true, 
      "title": "Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

QosBaseRateShaper (type) 

{
  "abstract": true, 
  "id": "QosBaseRateShaper", 
  "module_id": "QosSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "property-name": "resource_type"
  }, 
  "properties": {
    "enabled": {
      "required": true, 
      "type": "boolean"
    }, 
    "resource_type": {
      "default": "IngressRateShaper", 
      "enum": [
        "IngressRateShaper", 
        "IngressBroadcastRateShaper", 
        "EgressRateShaper"
      ], 
      "type": "string"
    }
  }, 
  "title": "A shaper configuration entry that specifies type and metrics", 
  "type": "object"
}

QosSwitchingProfile (type) 

{
  "extends": {
    "$ref": "BaseSwitchingProfile"+
  }, 
  "id": "QosSwitchingProfile", 
  "module_id": "QosSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "QosSwitchingProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "class_of_service": {
      "default": 0, 
      "maximum": 7, 
      "minimum": 0, 
      "title": "Class of service", 
      "type": "int"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "dscp": {
      "$ref": "Dscp"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n", 
      "required": true, 
      "type": "string"
    }, 
    "shaper_configuration": {
      "items": {
        "$ref": "QosBaseRateShaper"+
      }, 
      "maxItems": 3, 
      "minItems": 0, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

QueryTunnelParameters (type) 

{
  "extends": {
    "$ref": "ListWithDataSourceParameters"+
  }, 
  "id": "QueryTunnelParameters", 
  "module_id": "Tunnel", 
  "properties": {
    "bfd_diagnostic_code": {
      "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"
      ], 
      "title": "BFD diagnostic code of Tunnel as defined in RFC 5880", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "remote_node_id": {
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "title": "Tunnel status", 
      "type": "string"
    }
  }, 
  "type": "object"
}

QuickSearchResponse (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "QuickSearchResponse", 
  "module_id": "Search", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "result_count": {
      "required": true, 
      "title": "Result count", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TypeGroup"+
      }, 
      "required": true, 
      "title": "Search results", 
      "type": "array"
    }
  }, 
  "type": "object"
}

RateLimits (type) 

{
  "description": "Enables traffic limit for incoming/outgoing broadcast and multicast packets. Use 0 to disable rate limiting for a specific traffic type", 
  "id": "RateLimits", 
  "module_id": "SwitchSecuritySwitchingProfile", 
  "properties": {
    "enabled": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Whether rate limiting is enabled", 
      "type": "boolean"
    }, 
    "rx_broadcast": {
      "default": 0, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Incoming broadcast traffic limit in packets per second", 
      "type": "int"
    }, 
    "rx_multicast": {
      "default": 0, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Incoming multicast traffic limit in packets per second", 
      "type": "int"
    }, 
    "tx_broadcast": {
      "default": 0, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Outgoing broadcast traffic limit in packets per second", 
      "type": "int"
    }, 
    "tx_multicast": {
      "default": 0, 
      "minimum": 0, 
      "readonly": false, 
      "required": false, 
      "title": "Outgoing multicast traffic limit in packets per second", 
      "type": "int"
    }
  }, 
  "title": "Rate limiting configuration", 
  "type": "object"
}

RealizationStateBarrierConfig (type) 

{
  "description": "The configuration data for setting the global realization state barrier\n", 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "RealizationStateBarrierConfig", 
  "module_id": "RealizationStateBarrier", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "interval": {
      "description": "The interval in milliseconds used for auto incrementing the barrier number\n", 
      "minimum": 0, 
      "readonly": false, 
      "required": true, 
      "title": "Interval in milliseconds", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

RedistributionConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "RedistributionConfig", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bgp_enabled": {
      "default": false, 
      "required": false, 
      "title": "Flag to enable redistribution for BGP as destinationProtocol", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

RedistributionProtocols (type) 

{
  "additionalProperties": false, 
  "description": "Types of route to redistribute over routing protocols.\nSTATIC type should be used to redistribute user added static\nroutes.\nNSX_CONNECTED type should be used to redistribute downlink port\nsubnets.\nNSX_STATIC type should be used to redistribute nsx-connected and\nstatic routes advertised by TIER1 logical router.\nTIER0_NAT type should be used to redistribute NAT IPs owned by\nTIER0 logical router.\nTIER1_NAT type should be used to redistribute NAT IPs advertised\nby TIER1 logical router.\nTIER1_LB_VIP type should be used to redistribute LB VIP IPs\nadvertised by TIER1 logical router.\nTIER1_LB_SNAT type should be used to redistribute LB SNAT IPs\nadvertised by TIER1 logical router.\nBGP type should be used to redistribute routes learned via BGP.\n", 
  "enum": [
    "STATIC", 
    "NSX_CONNECTED", 
    "NSX_STATIC", 
    "TIER0_NAT", 
    "TIER1_NAT", 
    "TIER1_LB_VIP", 
    "TIER1_LB_SNAT", 
    "BGP"
  ], 
  "id": "RedistributionProtocols", 
  "module_id": "Routing", 
  "title": "Redistribution Protocols", 
  "type": "string"
}

RedistributionRule (type) 

{
  "additionalProperties": false, 
  "id": "RedistributionRule", 
  "module_id": "Routing", 
  "properties": {
    "description": {
      "maxLength": 1024, 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "destination": {
      "$ref": "RedistributionProtocols"+, 
      "required": true, 
      "title": "Destination redistribution protocol"
    }, 
    "display_name": {
      "maxLength": 255, 
      "required": false, 
      "title": "Display name", 
      "type": "string"
    }, 
    "route_map_id": {
      "required": false, 
      "title": "RouteMap Id for the filter", 
      "type": "string"
    }, 
    "sources": {
      "items": {
        "$ref": "RedistributionProtocols"+
      }, 
      "required": true, 
      "title": "Array of redistribution protocols", 
      "type": "array"
    }
  }, 
  "type": "object"
}

RedistributionRuleList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "RedistributionRuleList", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rules": {
      "default": [], 
      "items": {
        "$ref": "RedistributionRule"+
      }, 
      "maxItems": 5, 
      "minItems": 0, 
      "required": false, 
      "title": "List of redistribution rules.\nUser needs to re-order rules to change the priority.\n", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

RegistrationToken (type) 

{
  "id": "RegistrationToken", 
  "module_id": "RegistrationTokenEndPoint", 
  "properties": {
    "roles": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "token": {
      "required": true, 
      "title": "Access token", 
      "type": "string"
    }
  }, 
  "title": "Appliance registration access token", 
  "type": "object"
}

RelatedApiError (type) 

{
  "id": "RelatedApiError", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "title": "Further details about the error", 
      "type": "string"
    }, 
    "error_code": {
      "title": "A numeric error code", 
      "type": "integer"
    }, 
    "error_data": {
      "title": "Additional data about the error", 
      "type": "object"
    }, 
    "error_message": {
      "title": "A description of the error", 
      "type": "string"
    }, 
    "module_name": {
      "title": "The module name where the error occurred", 
      "type": "string"
    }
  }, 
  "title": "Detailed information about a related API error", 
  "type": "object"
}

RelatedData (type) 

{
  "additionalProperties": false, 
  "description": "The results array will contain all the related objects\n", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RelatedData", 
  "module_id": "Search", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "alias": {
      "description": "Alias for the related type", 
      "required": false, 
      "title": "Alias", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Array of related objects", 
      "items": {
        "type": "object"
      }, 
      "required": true, 
      "title": "Related objects", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Related object details", 
  "type": "object"
}

RelatedDataRequest (type) 

{
  "additionalProperties": false, 
  "description": "Request parameters for the related types", 
  "extends": {
    "$ref": "AggregateRequest"+
  }, 
  "id": "RelatedDataRequest", 
  "module_id": "Search", 
  "properties": {
    "alias": {
      "description": "Alias for the response", 
      "required": false, 
      "title": "Alias", 
      "type": "string"
    }, 
    "filters": {
      "description": "An array of filter conditions", 
      "items": {
        "$ref": "FilterRequest"+
      }, 
      "required": false, 
      "title": "Filter conditions", 
      "type": "array"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "join_condition": {
      "description": "Join condition between the parent and the related object.\nThis is to be specified in \"relatedObjectFieldName:ParentObjectFieldName\" format.\n", 
      "required": true, 
      "title": "Join condition", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Resource type name", 
      "required": true, 
      "title": "Resource Type", 
      "type": "string"
    }, 
    "size": {
      "description": "Number of related objects to return.\nIf not specified all the related objects will be returned.\nShould be set to 0 if only the count of related objects is desired.\n", 
      "required": false, 
      "title": "Size", 
      "type": "integer"
    }
  }, 
  "title": "Related object request", 
  "type": "object"
}

RemainingSupportBundleNode (type) 

{
  "additionalProperties": false, 
  "id": "RemainingSupportBundleNode", 
  "properties": {
    "node_display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Display name of node", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "UUID of node", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "PENDING", 
        "PROCESSING"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RemoteFileServer (type) 

{
  "additionalProperties": false, 
  "id": "RemoteFileServer", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "directory_path": {
      "pattern": "^\\/[\\w\\-.\\+~%\\/]+$", 
      "required": true, 
      "title": "Remote server directory to copy bundle files to", 
      "type": "string", 
      "validation_msg_key": "com.vmware.nsx.validation.constraints.BackupRestore.directory_path_pattern.message"
    }, 
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "FileTransferProtocol"+, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }
  }, 
  "title": "Remote file server", 
  "type": "object"
}

RemoteServerFingerprint (type) 

{
  "additionalProperties": false, 
  "id": "RemoteServerFingerprint", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "title": "Remote server", 
  "type": "object"
}

RemoteServerFingerprintRequest (type) 

{
  "additionalProperties": false, 
  "id": "RemoteServerFingerprintRequest", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "server": {
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }
  }, 
  "title": "Remote server", 
  "type": "object"
}

RemoteTransportNodeStatusParametersWithDataSource (type) 

{
  "description": "Query parameters that may be used to select which transport nodes status to return in a query.\nThe tunnel_status and bfd_diagnostic_code parameters are ANDed together if both are provided.\n", 
  "extends": {
    "$ref": "ListWithDataSourceParameters"+
  }, 
  "id": "RemoteTransportNodeStatusParametersWithDataSource", 
  "module_id": "Heatmap", 
  "properties": {
    "bfd_diagnostic_code": {
      "description": "If specified, only the status for transport nodes connected via tunnels having the\nspecified BFD diagnostic code are returned.\n", 
      "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"
      ], 
      "title": "BFD diagnostic code of Tunnel as defined in RFC 5880", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "tunnel_status": {
      "description": "If specified, only the status for transport nodes connected via tunnels having the\nspecified tunnel status are returned.\n", 
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "title": "Tunnel Status", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RenderConfiguration (type) 

{
  "additionalProperties": false, 
  "description": "Render configuration to be applied to the widget.", 
  "id": "RenderConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "color": {
      "description": "The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.", 
      "enum": [
        "GREY", 
        "SKY_BLUE", 
        "BLUE", 
        "GREEN", 
        "YELLOW", 
        "RED"
      ], 
      "title": "Color of the entity", 
      "type": "string"
    }, 
    "condition": {
      "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.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "display_value": {
      "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.", 
      "maxLength": 255, 
      "title": "Overridden value to display, if any", 
      "type": "string"
    }, 
    "icons": {
      "description": "Icons to be applied at dashboard for widgets and UI elements.", 
      "items": {
        "$ref": "Icon"+
      }, 
      "minItems": 0, 
      "title": "Icons", 
      "type": "array"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.", 
      "items": {
        "$ref": "Tooltip"+
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }
  }, 
  "title": "Render Configuration", 
  "type": "object"
}

ReorderRequest (type) 

{
  "additionalProperties": false, 
  "id": "ReorderRequest", 
  "module_id": "Upgrade", 
  "properties": {
    "id": {
      "readonly": false, 
      "required": true, 
      "title": "id of the upgrade unit group/upgrade unit before/after which the upgrade unit group/upgrade unit is to be placed", 
      "type": "string"
    }, 
    "is_before": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "flag indicating whether the upgrade unit group/upgrade unit is to be placed before or after the specified upgrade unit group/upgrade unit", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

RequestParametersWithResoureType (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RequestParametersWithResoureType", 
  "module_id": "EdgeCommonTypes", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "required": false, 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RequiredTransportNodeIdParameters (type) 

{
  "extends": {
    "$ref": "DataSourceParameters"+
  }, 
  "id": "RequiredTransportNodeIdParameters", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": true, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Resource (type) 

{
  "abstract": true, 
  "id": "Resource", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }
  }, 
  "title": "Base class for resources", 
  "type": "object"
}

ResourceAllocation (type) 

{
  "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", 
  "id": "ResourceAllocation", 
  "module_id": "NiocProfile", 
  "nsx_feature": "Nioc", 
  "properties": {
    "limit": {
      "default": -1.0, 
      "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", 
      "maximum": 100, 
      "minimum": -1, 
      "required": true, 
      "title": "Maximum bandwidth percentage", 
      "type": "number"
    }, 
    "reservation": {
      "default": 0.0, 
      "maximum": 75, 
      "minimum": 0, 
      "required": true, 
      "title": "Minimum guaranteed bandwidth percentage", 
      "type": "number"
    }, 
    "shares": {
      "default": 50, 
      "maximum": 100, 
      "minimum": 1, 
      "required": true, 
      "title": "Shares", 
      "type": "int"
    }, 
    "traffic_type": {
      "$ref": "HostInfraTrafficType"+, 
      "required": true, 
      "title": "Resource allocation traffic type"
    }
  }, 
  "title": "Resource allocation information for a host infrastructure traffic type", 
  "type": "object"
}

ResourceLink (type) 

{
  "additionalProperties": false, 
  "id": "ResourceLink", 
  "module_id": "Common", 
  "properties": {
    "action": {
      "readonly": true, 
      "title": "Optional action", 
      "type": "string"
    }, 
    "href": {
      "readonly": true, 
      "required": true, 
      "title": "Link to resource", 
      "type": "string"
    }, 
    "rel": {
      "description": "Custom relation type (follows RFC 5988 where appropriate definitions exist)", 
      "readonly": true, 
      "required": true, 
      "title": "Link relation type", 
      "type": "string"
    }
  }, 
  "title": "A link to a related resource", 
  "type": "object"
}

ResourceReference (type) 

{
  "description": "A weak reference to an NSX resource.", 
  "id": "ResourceReference", 
  "module_id": "Common", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RestoreConfiguration (type) 

{
  "additionalProperties": false, 
  "id": "RestoreConfiguration", 
  "module_id": "BackupConfiguration", 
  "properties": {
    "passphrase": {
      "sensitive": true, 
      "title": "Passphrase used to encrypt backup files.", 
      "type": "string"
    }, 
    "remote_file_server": {
      "$ref": "RemoteFileServer"+, 
      "required": true, 
      "title": "The server from which backup files will be retrieved for restore."
    }
  }, 
  "title": "Configuration where backup files are stored for restore", 
  "type": "object"
}

RestoreStep (type) 

{
  "id": "RestoreStep", 
  "module_id": "ClusterRestore", 
  "properties": {
    "description": {
      "readonly": true, 
      "required": true, 
      "title": "Restore step description", 
      "type": "string"
    }, 
    "status": {
      "$ref": "PerStepRestoreStatus"+
    }, 
    "step_number": {
      "readonly": true, 
      "required": true, 
      "title": "Restore step number", 
      "type": "integer"
    }, 
    "value": {
      "readonly": true, 
      "required": true, 
      "title": "Restore step value", 
      "type": "string"
    }
  }, 
  "title": "Restore step info", 
  "type": "object"
}

RevisionedResource (type) 

{
  "abstract": true, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "RevisionedResource", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }
  }, 
  "title": "A base class for types that track revisions", 
  "type": "object"
}

Role (type) 

{
  "id": "Role", 
  "module_id": "AAA", 
  "properties": {
    "role": {
      "required": true, 
      "title": "Role name", 
      "type": "string"
    }
  }, 
  "title": "Role", 
  "type": "object"
}

RoleBinding (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "RoleBinding", 
  "module_id": "AAA", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "User/Group's name", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "roles": {
      "items": {
        "$ref": "Role"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Roles", 
      "type": "array"
    }, 
    "stale": {
      "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", 
      "enum": [
        "TRUE", 
        "FALSE", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Stale in vIDM", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "enum": [
        "remote_user", 
        "remote_group", 
        "local_user", 
        "principal_identity"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type", 
      "type": "string"
    }
  }, 
  "title": "User/Group's role binding", 
  "type": "object"
}

RoleBindingListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RoleBindingListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "RoleBinding"+
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RoleBindingRequestParameters (type) 

{
  "description": "Pagination and Filtering parameters to get only a subset of users/groups.", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RoleBindingRequestParameters", 
  "module_id": "AAA", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "name": {
      "required": false, 
      "title": "User/Group name", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "type": {
      "enum": [
        "remote_user", 
        "remote_group", 
        "local_user", 
        "principal_identity"
      ], 
      "required": false, 
      "title": "Type", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter list of role bindings.", 
  "type": "object"
}

RoleListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RoleListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Role"+
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RoleWithFeatures (type) 

{
  "id": "RoleWithFeatures", 
  "module_id": "AAA", 
  "properties": {
    "features": {
      "items": {
        "$ref": "FeaturePermission"+
      }, 
      "required": true, 
      "title": "Features", 
      "type": "array"
    }, 
    "role": {
      "readonly": true, 
      "required": true, 
      "title": "Role name", 
      "type": "string"
    }
  }, 
  "title": "Role", 
  "type": "object"
}

RouteBasedIPSecVPNSession (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "IPSecVPNSession"+
  }, 
  "id": "RouteBasedIPSecVPNSession", 
  "module_id": "IPSecVPN", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RouteBasedIPSecVPNSession"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Enable/Disable IPSec VPN session.", 
      "title": "Enable/Disable IPSec VPN session", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipsec_vpn_service_id": {
      "description": "Identifier of VPN Service linked with local endpoint.", 
      "readonly": true, 
      "title": "IPSec VPN service identifier", 
      "type": "string"
    }, 
    "local_endpoint_id": {
      "description": "Local endpoint identifier.", 
      "required": true, 
      "title": "Local endpoint identifier", 
      "type": "string"
    }, 
    "peer_endpoint_id": {
      "description": "Peer endpoint identifier.", 
      "required": true, 
      "title": "Peer endpoint identifier", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "IPSecVPNSessionResourceType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tunnel_ports": {
      "description": "IP Tunnel ports.", 
      "items": {
        "$ref": "TunnelPortConfig"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IP Tunnel ports", 
      "type": "array"
    }
  }, 
  "title": "Route based VPN session", 
  "type": "object"
}

RouteMap (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "RouteMap", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sequences": {
      "items": {
        "$ref": "RouteMapSequence"+
      }, 
      "maxItems": 1000, 
      "minItems": 1, 
      "required": true, 
      "title": "Ordered list of routeMap sequences", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

RouteMapListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RouteMapListResult", 
  "module_id": "Routing", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "RouteMap"+
      }, 
      "required": true, 
      "title": "Paginated list of RouteMaps", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RouteMapSequence (type) 

{
  "additionalProperties": false, 
  "id": "RouteMapSequence", 
  "module_id": "Routing", 
  "properties": {
    "action": {
      "$ref": "RoutingFilterAction"+, 
      "required": true, 
      "title": "Action for the Sequence"
    }, 
    "match_criteria": {
      "$ref": "RouteMapSequenceMatch"+, 
      "required": true, 
      "title": "Match Criteria for the RouteMap Sequence"
    }, 
    "set_criteria": {
      "$ref": "RouteMapSequenceSet"+, 
      "required": false, 
      "title": "Set Criteria for the RouteMap Sequence"
    }
  }, 
  "type": "object"
}

RouteMapSequenceMatch (type) 

{
  "additionalProperties": false, 
  "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", 
  "id": "RouteMapSequenceMatch", 
  "module_id": "Routing", 
  "properties": {
    "ip_prefix_lists": {
      "items": {
        "type": "string"
      }, 
      "maxItems": 500, 
      "minItems": 1, 
      "title": "IPPrefixList Identifiers for RouteMap Sequence Match Criteria", 
      "type": "array"
    }, 
    "match_community_expression": {
      "$ref": "CommunityMatchExpression"+, 
      "description": "It supports conjunction operator (AND) and five\noperators within singular community match expression\n(MATCH_ANY, MATCH_ALL, MATCH_EXACT, MATCH_NONE,\nMATCH_REGEX).\n", 
      "title": "Expression to match BGP communities"
    }
  }, 
  "type": "object"
}

RouteMapSequenceSet (type) 

{
  "additionalProperties": false, 
  "id": "RouteMapSequenceSet", 
  "module_id": "Routing", 
  "properties": {
    "as_path_prepend": {
      "required": false, 
      "title": "As Path Prepending to influence path selection", 
      "type": "string"
    }, 
    "community": {
      "required": false, 
      "title": "Either well-known community name or community value in aa:nn(2byte:2byte) format", 
      "type": "string"
    }, 
    "multi_exit_discriminator": {
      "maximum": 4294967295, 
      "minimum": 0, 
      "required": false, 
      "title": "Multi Exit Discriminator (MED)", 
      "type": "integer"
    }, 
    "weight": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": false, 
      "title": "Weight used to select certain path", 
      "type": "int"
    }
  }, 
  "type": "object"
}

RoutingConfig (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "RoutingConfig", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "forwarding_up_timer": {
      "default": 0, 
      "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.\n", 
      "required": false, 
      "title": "Forwarding up timer", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

RoutingFilterAction (type) 

{
  "additionalProperties": false, 
  "enum": [
    "PERMIT", 
    "DENY"
  ], 
  "id": "RoutingFilterAction", 
  "module_id": "Routing", 
  "title": "Action for Filters in Routing", 
  "type": "string"
}

RowListField (type) 

{
  "additionalProperties": false, 
  "description": "Root of the api result set for forming rows.", 
  "id": "RowListField", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alias": {
      "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 $<index> (for example, $0).", 
      "maxLength": 255, 
      "title": "Alias Name", 
      "type": "string"
    }, 
    "path": {
      "description": "JSON path to the root of the api result set for forming rows.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "JSON path", 
      "type": "string"
    }
  }, 
  "title": "List of fields from which rows are formed", 
  "type": "object"
}

RuleState (type) 

{
  "extends": {
    "$ref": "DSRuleState"+
  }, 
  "id": "RuleState", 
  "module_id": "Firewall", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "revision_desired": {
      "readonly": true, 
      "required": false, 
      "title": "revision number of the desired state", 
      "type": "integer"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SVMDeploymentSpec (type) 

{
  "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.", 
  "id": "SVMDeploymentSpec", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "host_type": {
      "description": "Host Type on which the specified OVF can be deployed.", 
      "enum": [
        "ESXI", 
        "RHELKVM", 
        "UBUNTUKVM"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "HostType", 
      "type": "string"
    }, 
    "name": {
      "description": "Deployment Spec name for ease of use, since multiple DeploymentSpec can be specified.", 
      "readonly": false, 
      "required": false, 
      "title": "name", 
      "type": "string"
    }, 
    "ovf_url": {
      "description": "Location of the partner VM OVF to be deployed.", 
      "readonly": false, 
      "required": true, 
      "title": "OVF url", 
      "type": "string"
    }, 
    "service_form_factor": {
      "default": "MEDIUM", 
      "description": "Supported ServiceInsertion Form Factor for the OVF deployment. The default FormFactor is Medium.", 
      "enum": [
        "SMALL", 
        "MEDIUM", 
        "LARGE"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Service Form Factor", 
      "type": "string"
    }
  }, 
  "title": "Service-VM Deployment Spec", 
  "type": "object"
}

SavedSearch (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "SavedSearch", 
  "module_id": "Search", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_saved": {
      "description": "The flag indicates whether the saved query is saved search or recent search.", 
      "required": true, 
      "title": "Flag", 
      "type": "boolean"
    }, 
    "query": {
      "description": "The search query that is to be saved.", 
      "required": true, 
      "title": "Search string", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

SavedSearchListRequest (type) 

{
  "additionalProperties": false, 
  "description": "The request will contain the flag indicating whether the saved searches or the recent searches\nis to be fetched.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "SavedSearchListRequest", 
  "module_id": "Search", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "is_saved": {
      "description": "If true, only saved searches will be returned. If false, only recent searches will be\nreturned.\n", 
      "required": true, 
      "title": "Flag", 
      "type": "boolean"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Request to get the list of all saved or recent searches", 
  "type": "object"
}

SavedSearchListResult (type) 

{
  "additionalProperties": false, 
  "description": "The results array will contain all the saved or recent search objects.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "SavedSearchListResult", 
  "module_id": "Search", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "The list of all saved searches by the user.", 
      "items": {
        "$ref": "SavedSearch"+
      }, 
      "required": true, 
      "title": "Saved search list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of all Saved or recent searches", 
  "type": "object"
}

SavedSearchRequest (type) 

{
  "additionalProperties": false, 
  "description": "The request will contain the query to be saved and the flag indicating whether it is recent or\nsaved search.\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "SavedSearchRequest", 
  "module_id": "Search", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_saved": {
      "description": "The flag indicates whether the query is recent or saved search.", 
      "required": true, 
      "title": "Flag", 
      "type": "boolean"
    }, 
    "query": {
      "description": "The search query that has to be saved.", 
      "required": true, 
      "title": "search query", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Save a search request", 
  "type": "object"
}

ScpProtocol (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol"+
  }, 
  "id": "ScpProtocol", 
  "polymorphic-type-descriptor": {
    "type-identifier": "scp"
  }, 
  "properties": {
    "authentication_scheme": {
      "$ref": "PasswordAuthenticationScheme"+, 
      "required": true, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SearchRequest (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "SearchRequest", 
  "module_id": "Search", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "dsl": {
      "description": "It's human readable and context-based query language for retrieving\ninformation from search indices.\nFor example: Find router where ip is 10.10.1.10\n", 
      "required": false, 
      "title": "Search DSL (domain specific language) query", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "query": {
      "required": true, 
      "title": "Search query", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SearchResponse (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "SearchResponse", 
  "module_id": "Search", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "type": "object"
      }, 
      "required": true, 
      "title": "Search results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SelectableResourceReference (type) 

{
  "extends": {
    "$ref": "ResourceReference"+
  }, 
  "id": "SelectableResourceReference", 
  "module_id": "ClusterRestore", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "selected": {
      "required": true, 
      "title": "Set to true if this resource has been selected to be acted upon", 
      "type": "boolean"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "title": "Resources to take action on", 
  "type": "object"
}

SelfResourceLink (type) 

{
  "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
  "extends": {
    "$ref": "ResourceLink"+
  }, 
  "id": "SelfResourceLink", 
  "module_id": "Common", 
  "properties": {
    "action": {
      "readonly": true, 
      "title": "Optional action", 
      "type": "string"
    }, 
    "href": {
      "readonly": true, 
      "required": true, 
      "title": "Link to resource", 
      "type": "string"
    }, 
    "rel": {
      "description": "Custom relation type (follows RFC 5988 where appropriate definitions exist)", 
      "readonly": true, 
      "required": true, 
      "title": "Link relation type", 
      "type": "string"
    }
  }, 
  "title": "Link to this resource", 
  "type": "object"
}

SelfSignedActionParameter (type) 

{
  "additionalProperties": false, 
  "id": "SelfSignedActionParameter", 
  "module_id": "CertificateManager", 
  "properties": {
    "days_valid": {
      "default": 3650, 
      "maximum": 10000, 
      "minimum": 1, 
      "required": true, 
      "title": "Number of days the certificate will be valid, default 10 years", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

ServerAuthType (type) 

{
  "additionalProperties": false, 
  "description": "Server authentication could be REQUIRED or IGNORE, it is used to specify\nif the server certificate presented to the load balancer during handshake\nshould be actually validated or not. Validation is disabled by default.\nIf validation is REQUIRED, then to be accepted, server certificate must be\nsigned by one of the trusted CAs whose self signed certificates are\nspecified in the same server-side SSL profile binding.\n", 
  "enum": [
    "REQUIRED", 
    "IGNORE"
  ], 
  "id": "ServerAuthType", 
  "module_id": "LoadBalancer", 
  "title": "server authentication mode", 
  "type": "string"
}

ServerSslProfileBinding (type) 

{
  "additionalProperties": false, 
  "id": "ServerSslProfileBinding", 
  "module_id": "LoadBalancer", 
  "properties": {
    "certificate_chain_depth": {
      "default": 3, 
      "description": "authentication depth is used to set the verification depth in the server\ncertificates chain.\n", 
      "maximum": 2147483647, 
      "minimum": 1, 
      "required": false, 
      "title": "the maximum traversal depth of server certificate chain", 
      "type": "integer"
    }, 
    "client_certificate_id": {
      "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", 
      "required": false, 
      "title": "client certificate identifier", 
      "type": "string"
    }, 
    "server_auth": {
      "$ref": "ServerAuthType"+, 
      "default": "IGNORE", 
      "title": "server authentication mode"
    }, 
    "server_auth_ca_ids": {
      "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", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CA identifier list to verify server certificate", 
      "type": "array"
    }, 
    "server_auth_crl_ids": {
      "description": "A Certificate Revocation List (CRL) can be specified in the server-side\nSSL profile binding to disallow compromised server certificates.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "CRL identifier list to verify server certificate", 
      "type": "array"
    }, 
    "ssl_profile_id": {
      "description": "Server SSL profile defines reusable, application-independent server side\nSSL properties.\n", 
      "required": false, 
      "title": "server SSL profile identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ServiceAssociationListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceAssociationListResult", 
  "module_id": "GroupingObjectsProviders", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "service_type"
  }, 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "service_type": {
      "enum": [
        "FireWallServiceAssociationListResult", 
        "IpfixServiceAssociationListResult"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ServiceAttachment (type) 

{
  "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.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ServiceAttachment", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attachment_status": {
      "default": "UP", 
      "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.", 
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Attachment Status", 
      "type": "string"
    }, 
    "deployed_to": {
      "$ref": "ResourceReference"+, 
      "description": "NSX Resource where we want to create Service Attachment Point. Ex. T0 LR Edge in case of HCX-ServiceInsertion.", 
      "readonly": false, 
      "required": true, 
      "title": "Deployed-to object"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "local_ips": {
      "description": "Local IPs associated with this Service Attachment.", 
      "items": {
        "$ref": "IPInfo"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "Local IPs", 
      "type": "array"
    }, 
    "logical_switch": {
      "$ref": "ResourceReference"+, 
      "description": "Logical Switch gets created as a part of Service Attachment creation. If a Logical Switch is provided, then that needs to be used  - instead of creating new one.", 
      "readonly": true, 
      "required": false, 
      "title": "Logical Switch"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "service_port": {
      "$ref": "ResourceReference"+, 
      "description": "Service Port gets created as a part of Service Attachment creation. It is a Logical Router Port of type CentralizedServicePort. It does not participate in distributed routing. Stateless Policy Based Routing service can be applied on this port.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Port (Logical Router Centralized Service Port)"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Logical Attachment Point for a 3rd Party Service", 
  "type": "object"
}

ServiceAttachmentListResult (type) 

{
  "description": "List of Service Attachments.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceAttachmentListResult", 
  "module_id": "ServiceInsertion", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of the Service Attachments.", 
      "items": {
        "$ref": "ServiceAttachment"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Service-Attachment list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Service Attachment List", 
  "type": "object"
}

ServiceBinding (type) 

{
  "additionalProperties": false, 
  "id": "ServiceBinding", 
  "module_id": "LogicalRouterPorts", 
  "properties": {
    "service_id": {
      "$ref": "ResourceReference"+, 
      "description": "Identifier of Logical Service", 
      "required": true, 
      "title": "UUID of Service"
    }
  }, 
  "type": "object"
}

ServiceDefinition (type) 

{
  "description": "Registering a Service is the first step in the ServiceInsertion mechanism. A ServiceDefinition is used to create a service.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ServiceDefinition", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attachment_point": {
      "description": "The point at which the service is deployed/attached for redirecting the traffic to the the partner appliance.", 
      "items": {
        "enum": [
          "TIER0_LR", 
          "TIER1_LR"
        ], 
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Attachment Point", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "functionalities": {
      "description": "The capabilities provided by the services like NG_FW, IDS_IPS Hybrid Cloud Exchange(HCX) is specified here.", 
      "items": {
        "enum": [
          "NG_FW", 
          "IDS_IPS", 
          "HCX"
        ], 
        "type": "string"
      }, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Functionality Type", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "implementations": {
      "description": "This indicates the insertion point of the service.", 
      "items": {
        "enum": [
          "NORTH_SOUTH", 
          "EAST_WEST"
        ], 
        "type": "string"
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Implementation Type", 
      "type": "array"
    }, 
    "on_failure_policy": {
      "default": "ALLOW", 
      "description": "Failure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "On Failure Policy", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "service_deployment_spec": {
      "$ref": "ServiceDeploymentSpec"+, 
      "description": "Service Deployment Specification defines takes in information required to deploy and configure a partner appliance/service-vm.", 
      "readonly": false, 
      "required": false, 
      "title": "Service Deployment Specification"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transports": {
      "description": "Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance.", 
      "items": {
        "enum": [
          "L2_BRIDGE", 
          "L3_ROUTED"
        ], 
        "type": "string"
      }, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Transport Type", 
      "type": "array"
    }, 
    "vendor_id": {
      "description": "Id which is unique to a vendor or partner for which the service is created.", 
      "readonly": false, 
      "required": true, 
      "title": "Vendor ID", 
      "type": "string"
    }
  }, 
  "title": "Definition of a Service.", 
  "type": "object"
}

ServiceDeploymentSpec (type) 

{
  "description": "ServiceDeployment Spec consists of information required to deploy and configure the partner appliances. viz. Deployment template, deployment spec and NIC metatdata.", 
  "id": "ServiceDeploymentSpec", 
  "module_id": "ServiceInsertionCommonTypes", 
  "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.", 
      "items": {
        "$ref": "SVMDeploymentSpec"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Service Deployment Spec List", 
      "type": "array"
    }, 
    "deployment_template": {
      "description": "Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX Manager.", 
      "items": {
        "$ref": "DeploymentTemplate"+
      }, 
      "readonly": false, 
      "required": true, 
      "title": "Service Deployment Template", 
      "type": "array"
    }, 
    "nic_metadata_list": {
      "description": "NIC metadata associated with the deployment spec.", 
      "items": {
        "$ref": "NicMetadata"+
      }, 
      "readonly": false, 
      "required": false, 
      "title": "NIC Metadata", 
      "type": "array"
    }
  }, 
  "title": "Service Deployment Specification.", 
  "type": "object"
}

ServiceEndpoint (type) 

{
  "additionalProperties": false, 
  "id": "ServiceEndpoint", 
  "module_id": "ClusterManagement", 
  "properties": {
    "certificate": {
      "required": false, 
      "type": "string"
    }, 
    "certificate_sha256_thumbprint": {
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "fqdn": {
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "ip_address": {
      "$ref": "IPAddress"+, 
      "required": true
    }, 
    "port": {
      "maximum": 65535, 
      "minimum": 0, 
      "required": true, 
      "type": "integer"
    }
  }, 
  "type": "object"
}

ServiceIP (type) 

{
  "additionalProperties": false, 
  "id": "ServiceIP", 
  "module_id": "L3", 
  "properties": {
    "ip_address": {
      "$ref": "IPv4Address"+, 
      "description": "Service IP address registerd by the service.", 
      "readonly": true, 
      "required": true, 
      "title": "Service IP address"
    }, 
    "is_advertised": {
      "default": false, 
      "description": "Flag to denote advertisement status of service IP to TIER0 LR.", 
      "readonly": true, 
      "required": false, 
      "title": "Flag to denote advertisement status of service IP", 
      "type": "boolean"
    }, 
    "is_arp_proxy_enabled": {
      "default": false, 
      "description": "Flag to denote status of ARP Proxy for service IP.", 
      "readonly": true, 
      "required": false, 
      "title": "Flag to denote status of ARP Proxy for service IP", 
      "type": "boolean"
    }, 
    "is_loopback_enabled": {
      "default": false, 
      "description": "Flag to denote loopback status for service IP.", 
      "readonly": true, 
      "required": false, 
      "title": "Flag to denote loopback status for service IP", 
      "type": "boolean"
    }, 
    "service": {
      "$ref": "ResourceReference"+, 
      "description": "Service which registered the ip.", 
      "readonly": true, 
      "required": true, 
      "title": "Service which registered the ip"
    }
  }, 
  "type": "object"
}

ServiceIPsListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ServiceIPsListParameters", 
  "module_id": "L3", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Service IP list parameters", 
  "type": "object"
}

ServiceIPsListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceIPsListResult", 
  "module_id": "L3", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of service IPs registered with the LR by services like NAT, LB, VPN, etc.", 
      "items": {
        "$ref": "ServiceIP"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Paginated list of service IPs", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ServiceInsertionListRequestParameters (type) 

{
  "description": "Pagination and Filtering parameters to get only a subset of sections/rules.", 
  "extends": {
    "$ref": "DSListRequestParameters"+
  }, 
  "id": "ServiceInsertionListRequestParameters", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type\n'FILTER' will ensure all criterias (sources, destinations, services,\nappliedtos) are matched. Type 'SEARCH' will match any of the given\ncriteria.\n", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter list of sections/rules", 
  "type": "object"
}

ServiceInsertionRule (type) 

{
  "description": "ServiceInsertion Rule.", 
  "extends": {
    "$ref": "DSRule"+
  }, 
  "id": "ServiceInsertionRule", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_owner": {
      "$ref": "OwnerResourceLink"+, 
      "readonly": true, 
      "title": "Owner of this resource"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "action": {
      "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).", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT", 
        "REDIRECT", 
        "DO_NOT_REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Action", 
      "type": "string"
    }, 
    "applied_tos": {
      "description": "List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destinations": {
      "description": "List of the destinations. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Destination List", 
      "type": "array"
    }, 
    "destinations_excluded": {
      "default": false, 
      "description": "Negation of the destination.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of destination", 
      "type": "boolean"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "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.", 
      "enum": [
        "IN", 
        "OUT", 
        "IN_OUT"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Rule direction", 
      "type": "string"
    }, 
    "disabled": {
      "default": false, 
      "description": "Flag to disable rule. Disabled will only be persisted but never provisioned/realized.", 
      "readonly": false, 
      "required": false, 
      "title": "Rule enable/disable flag", 
      "type": "boolean"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of the resource", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "ip_protocol": {
      "default": "IPV4_IPV6", 
      "description": "Type of IP packet that should be matched while enforcing the rule.", 
      "enum": [
        "IPV4", 
        "IPV6", 
        "IPV4_IPV6"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IPv4 vs IPv6 packet type", 
      "type": "string"
    }, 
    "is_default": {
      "description": "Flag to indicate whether rule is default.", 
      "readonly": true, 
      "required": false, 
      "title": "Default rule", 
      "type": "boolean"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "notes": {
      "description": "User notes specific to the rule.", 
      "maxLength": 2048, 
      "readonly": false, 
      "required": false, 
      "title": "Notes", 
      "type": "string"
    }, 
    "redirect_tos": {
      "description": "A rule can be realized on a particular service definition, service instance or instance endpoint. If a service definition is selected as a redirect_to target, by default it will take the first deployed service instance if finds.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Redirect_Tos List", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_tag": {
      "description": "User level field which will be printed in CLI and packet logs.", 
      "maxLength": 32, 
      "readonly": false, 
      "required": false, 
      "title": "Tag", 
      "type": "string"
    }, 
    "services": {
      "description": "List of the services. Null will be treated as any.", 
      "items": {
        "$ref": "ServiceInsertionService"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Service List", 
      "type": "array"
    }, 
    "sources": {
      "description": "List of sources. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "Source List", 
      "type": "array"
    }, 
    "sources_excluded": {
      "default": false, 
      "description": "Negation of the source.", 
      "readonly": false, 
      "required": false, 
      "title": "Negation of source", 
      "type": "boolean"
    }
  }, 
  "title": "ServiceInsertion Rule", 
  "type": "object"
}

ServiceInsertionRuleListResult (type) 

{
  "description": "List of ServiceInsertion Rules.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceInsertionRuleListResult", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "ServiceInsertion rule list result with pagination support.", 
      "items": {
        "$ref": "ServiceInsertionRule"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "ServiceInsertion rule list result", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ServiceInsertion Section RuleList", 
  "type": "object"
}

ServiceInsertionSection (type) 

{
  "description": "A ServiceInsertion section composed of ServiceInsertion Rules.", 
  "extends": {
    "$ref": "DSSection"+
  }, 
  "id": "ServiceInsertionSection", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "applied_tos": {
      "description": "List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Default section flag", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "section_type": {
      "description": "Type of the rules which a section can contain. Only homogeneous sections are supported.", 
      "enum": [
        "LAYER2", 
        "LAYER3", 
        "L3REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Section Type", 
      "type": "string"
    }, 
    "stateful": {
      "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.", 
      "readonly": false, 
      "required": true, 
      "title": "Stateful nature of the distributed service rules in the section.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "ServiceInsertion Section", 
  "type": "object"
}

ServiceInsertionSectionFilterParameters (type) 

{
  "description": "Pagination and Filtering parameters to get only a subset of sections.", 
  "extends": {
    "$ref": "ServiceInsertionListRequestParameters"+
  }, 
  "id": "ServiceInsertionSectionFilterParameters", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "applied_tos": {
      "description": "Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "AppliedTo's referenced by this section or section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "destinations": {
      "description": "The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Destinations referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "exclude_applied_to_type": {
      "$ref": "DSAppliedToType"+, 
      "description": "Used to filter out sections not having a specified AppliedTo target type. This parameter cannot be used along with include_applied_to_type parameter. Section filter only takes a single value for this param.", 
      "required": false, 
      "title": "Limit result to sections not having a specific AppliedTo type"
    }, 
    "filter_type": {
      "default": "FILTER", 
      "description": "Filter type defines matching criteria to qualify a rule in result. Type\n'FILTER' will ensure all criterias (sources, destinations, services,\nappliedtos) are matched. Type 'SEARCH' will match any of the given\ncriteria.\n", 
      "enum": [
        "FILTER", 
        "SEARCH"
      ], 
      "required": false, 
      "title": "Filter type", 
      "type": "string"
    }, 
    "include_applied_to_type": {
      "$ref": "DSAppliedToType"+, 
      "description": "Used to filter out results based on target type of a section's AppliedTo. Only sections with matching target type in its applied to will be returned. This parameter cannot be used along with exclude_applied_to_type parameter. Section filter only takes a single value for this param.", 
      "required": false, 
      "title": "Limit result to sections having a specific AppliedTo type"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "services": {
      "description": "Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "NSService referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sources": {
      "description": "The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.", 
      "required": false, 
      "title": "Sources referenced by this section's Distributed Service Rules .", 
      "type": "string"
    }, 
    "type": {
      "default": "L3REDIRECT", 
      "description": "Section Type with values L3REDIRECT.", 
      "enum": [
        "L3REDIRECT"
      ], 
      "required": false, 
      "title": "Section Type", 
      "type": "string"
    }
  }, 
  "title": "Parameters to filter section from list of sections", 
  "type": "object"
}

ServiceInsertionSectionListResult (type) 

{
  "description": "List of ServiceInsertion Sections.", 
  "extends": {
    "$ref": "DSSectionListResult"+
  }, 
  "id": "ServiceInsertionSectionListResult", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of the ServiceInsertion sections. The list has to be homogeneous.", 
      "items": {
        "$ref": "ServiceInsertionSection"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Section list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "ServiceInsertion Section List", 
  "type": "object"
}

ServiceInsertionSectionRuleList (type) 

{
  "description": "List of ServiceInsertion Rules.", 
  "extends": {
    "$ref": "ServiceInsertionSection"+
  }, 
  "id": "ServiceInsertionSectionRuleList", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "applied_tos": {
      "description": "List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": false, 
      "required": false, 
      "title": "AppliedTo List", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_default": {
      "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.", 
      "readonly": true, 
      "required": false, 
      "title": "Default section flag", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "rule_count": {
      "description": "Number of rules in this section.", 
      "readonly": true, 
      "required": false, 
      "title": "Rule count", 
      "type": "integer"
    }, 
    "rules": {
      "description": "List of Service Insertion rules in the section. Only homogeneous rules are supported.", 
      "items": {
        "$ref": "ServiceInsertionRule"+
      }, 
      "maxItems": 1000, 
      "readonly": false, 
      "required": true, 
      "title": "List of the Service Insertion rules", 
      "type": "array"
    }, 
    "section_type": {
      "description": "Type of the rules which a section can contain. Only homogeneous sections are supported.", 
      "enum": [
        "LAYER2", 
        "LAYER3", 
        "L3REDIRECT"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Section Type", 
      "type": "string"
    }, 
    "stateful": {
      "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.", 
      "readonly": false, 
      "required": true, 
      "title": "Stateful nature of the distributed service rules in the section.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "ServiceInsertion Section RuleList", 
  "type": "object"
}

ServiceInsertionService (type) 

{
  "description": "Protocol on which a particular ServiceInsertion Rule should apply to.", 
  "extends": {
    "$ref": "DSService"+
  }, 
  "id": "ServiceInsertionService", 
  "module_id": "ServiceInsertionRules", 
  "properties": {
    "is_valid": {
      "description": "Will be set to false if the referenced NSX resource has been deleted.", 
      "readonly": true, 
      "required": false, 
      "title": "Target validity", 
      "type": "boolean"
    }, 
    "service": {
      "$ref": "NSServiceElement"+, 
      "description": "Distributed Service API accepts raw protocol and ports as part of NS service element\nin Distributed Service Rule that describes traffic corresponding to an NSService.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Distributed Service Network and Security Service element"
    }, 
    "target_display_name": {
      "description": "Display name of the NSX resource.", 
      "maxLength": 255, 
      "readonly": true, 
      "required": false, 
      "title": "Target display name", 
      "type": "string"
    }, 
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_type": {
      "description": "Type of the NSX resource.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "Target type", 
      "type": "string"
    }
  }, 
  "title": "ServiceInsertion Service", 
  "type": "object"
}

ServiceInsertionServiceListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceInsertionServiceListResult", 
  "module_id": "ServiceInsertion", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of the Service-Insertion Services. The list has to be homogenous.", 
      "items": {
        "$ref": "ServiceDefinition"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Service list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Service List", 
  "type": "object"
}

ServiceInstance (type) 

{
  "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.", 
  "extends": {
    "$ref": "BaseServiceInstance"+
  }, 
  "id": "ServiceInstance", 
  "module_id": "ServiceInsertionCommonTypes", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ServiceInstance"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "attachment_point": {
      "description": "Attachment point to be used by this service instance for deploying the Service-VM.", 
      "enum": [
        "TIER0_LR", 
        "TIER1_LR"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Attachment Point", 
      "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.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "minItems": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Deployed-to object list", 
      "type": "array"
    }, 
    "deployment_mode": {
      "default": "ACTIVE_STANDBY", 
      "description": "Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.", 
      "enum": [
        "STAND_ALONE", 
        "ACTIVE_STANDBY"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Deployment Mode", 
      "type": "string"
    }, 
    "deployment_spec_name": {
      "description": "Name of the deployment spec to be used by this service instance.", 
      "readonly": false, 
      "required": true, 
      "title": "Deployment Spec Name", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "implementation_type": {
      "description": "Implementation to be used by this service instance for deploying the Service-VM.", 
      "enum": [
        "NORTH_SOUTH", 
        "EAST_WEST"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Implementation Type", 
      "type": "string"
    }, 
    "instance_deployment_config": {
      "$ref": "InstanceDeploymentConfig"+, 
      "description": "Instance Deployment Config contains the information to be injected during Service-VM deployment.", 
      "readonly": false, 
      "required": true, 
      "title": "Instance Deployment Config"
    }, 
    "instance_deployment_template": {
      "$ref": "DeploymentTemplate"+, 
      "description": "The deployment template to be used by this service instance. The attribute values specific to this instance can be added.", 
      "readonly": false, 
      "required": true, 
      "title": "Instance Deployment Template"
    }, 
    "on_failure_policy": {
      "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.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "required": false, 
      "title": "On Failure Policy", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ServiceInstanceResourceType"+, 
      "required": true
    }, 
    "service_id": {
      "description": "The Service to which the service instance is associated.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "description": "Transport to be used by this service instance for deploying the Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Transport Type", 
      "type": "string"
    }
  }, 
  "title": "Normal Instance of a service", 
  "type": "object"
}

ServiceInstanceListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceInstanceListResult", 
  "module_id": "ServiceInsertion", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of the Service-Insertion ServicesInstances. The list has to be homogenous.", 
      "items": {
        "$ref": "BaseServiceInstance"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Service-Instance list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Service Instance List", 
  "type": "object"
}

ServiceInstanceResourceType (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "ServiceInstanceResourceType", 
  "module_id": "ServiceInsertionCommonTypes", 
  "title": "Resource types of Service Instance", 
  "type": "string"
}

ServiceProfile (type) (Deprecated) 

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "ServiceProfile", 
  "module_id": "ServiceProfile", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ServiceProfileResourceTypes"+, 
      "required": true, 
      "title": "Resource type of the service profile"
    }, 
    "server_addresses": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": true, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

ServiceProfileListResult (type) (Deprecated) 

{
  "additionalProperties": false, 
  "deprecated": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceProfileListResult", 
  "module_id": "ServiceProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ServiceProfile"+
      }, 
      "required": true, 
      "title": "service profile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ServiceProfileResourceTypes (type) (Deprecated) 

{
  "deprecated": true, 
  "enum": [
    "DhcpRelayProfile"
  ], 
  "id": "ServiceProfileResourceTypes", 
  "module_id": "ServiceProfile", 
  "title": "Resource types of service profiles", 
  "type": "string"
}

ServiceType (type) 

{
  "enum": [
    "MGMT_CLUSTER", 
    "MGMT_PLANE", 
    "API"
  ], 
  "id": "ServiceType", 
  "module_id": "CertificateManager", 
  "title": "Supported service types, that are using certificates.", 
  "type": "string"
}

SessionSummaryParameters (type) 

{
  "additionalProperties": false, 
  "description": "IPSec VPN session summary parameters.", 
  "extends": {
    "$ref": "DataSourceParameters"+
  }, 
  "id": "SessionSummaryParameters", 
  "module_id": "VPNStatistics", 
  "properties": {
    "site_id": {
      "description": "Peer site id.", 
      "title": "Peer site id", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }
  }, 
  "title": "IPSec VPN session summary parameters", 
  "type": "object"
}

SftpProtocol (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol"+
  }, 
  "id": "SftpProtocol", 
  "polymorphic-type-descriptor": {
    "type-identifier": "sftp"
  }, 
  "properties": {
    "authentication_scheme": {
      "$ref": "PasswordAuthenticationScheme"+, 
      "required": true, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "http", 
        "https", 
        "scp", 
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SnatTranslationType (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "SnatTranslationType", 
  "module_id": "LoadBalancer", 
  "title": "Snat translation type", 
  "type": "string"
}

SnmpCommunity (type) 

{
  "additionalProperties": false, 
  "id": "SnmpCommunity", 
  "properties": {
    "access": {
      "default": "read_only", 
      "enum": [
        "read_only"
      ], 
      "title": "Type of access", 
      "type": "string"
    }, 
    "community_string": {
      "pattern": "^[\\S]{1,64}$", 
      "required": true, 
      "sensitive": true, 
      "title": "Community string at most 64 characters long", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SnmpServiceProperties (type) 

{
  "additionalProperties": false, 
  "id": "SnmpServiceProperties", 
  "properties": {
    "communities": {
      "items": {
        "$ref": "SnmpCommunity"+
      }, 
      "maxItems": 1, 
      "title": "SNMP v1, v2c community", 
      "type": "array"
    }, 
    "start_on_boot": {
      "required": true, 
      "title": "Start when system boots", 
      "type": "boolean"
    }
  }, 
  "title": "SNMP Service properties", 
  "type": "object"
}

SourceIpPersistencePurge (type) 

{
  "additionalProperties": false, 
  "description": "If the persistence table is full and a new connection without a matching persistence entry is received, then by default(FULL) oldest persistence entries are purged from the table to make space for new entries. Each time purging gets triggered, a small percentage of the entries are purged. If purging is disabled(NO_PURGE) and a new incoming connection requires a persistence entry to be created, then that connection is rejected even though backend servers are available.", 
  "enum": [
    "NO_PURGE", 
    "FULL"
  ], 
  "id": "SourceIpPersistencePurge", 
  "module_id": "LoadBalancer", 
  "title": "source ip persistence purge setting", 
  "type": "string"
}

SpoofGuardSwitchingProfile (type) 

{
  "extends": {
    "$ref": "BaseSwitchingProfile"+
  }, 
  "id": "SpoofGuardSwitchingProfile", 
  "module_id": "SpoofGuardSwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "SpoofGuardSwitchingProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "white_list_providers": {
      "help_detail": "SpoofGuard is considered to be disabled if no white-list providers\nare specified in the profile.\nIf multiple providers of address bindings are specificed, then the effective\naddress bindings is the intersection of all specificed bindings. In case if\nsuch effective address bindings is empty, then all packets are dropped.\n", 
      "items": {
        "$ref": "WhiteListProvisionType"+
      }, 
      "readonly": false, 
      "required": true, 
      "title": "List of providers for white listed address bindings.", 
      "type": "array"
    }
  }, 
  "title": "SpoofGuard configuration", 
  "type": "object"
}

SshKeyBaseProperties (type) 

{
  "additionalProperties": {}, 
  "id": "SshKeyBaseProperties", 
  "properties": {
    "label": {
      "required": true, 
      "title": "SSH key label (used to identify the key)", 
      "type": "string"
    }, 
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "Current password for user (required for users root and admin)", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SshKeyProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "SshKeyBaseProperties"+
  }, 
  "id": "SshKeyProperties", 
  "properties": {
    "label": {
      "required": true, 
      "title": "SSH key label (used to identify the key)", 
      "type": "string"
    }, 
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "Current password for user (required for users root and admin)", 
      "type": "string"
    }, 
    "type": {
      "pattern": "^(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-dss|ssh-ed25519|ssh-rsa)$", 
      "required": true, 
      "title": "SSH key type", 
      "type": "string"
    }, 
    "value": {
      "required": true, 
      "title": "SSH key value", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SshKeyPropertiesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "SshKeyPropertiesListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "SshKeyProperties"+
      }, 
      "required": true, 
      "title": "SSH key properties query results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "SSH key properties query results", 
  "type": "object"
}

SshServiceProperties (type) 

{
  "additionalProperties": false, 
  "id": "SshServiceProperties", 
  "properties": {
    "start_on_boot": {
      "required": true, 
      "title": "Start service when system boots", 
      "type": "boolean"
    }
  }, 
  "title": "SSH Service properties", 
  "type": "object"
}

SslCipher (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "SslCipher", 
  "module_id": "LoadBalancer", 
  "title": "SSL cipher", 
  "type": "string"
}

SslCipherGroup (type) 

{
  "additionalProperties": false, 
  "enum": [
    "BALANCED", 
    "HIGH_SECURITY", 
    "HIGH_COMPATIBILITY", 
    "CUSTOM"
  ], 
  "id": "SslCipherGroup", 
  "module_id": "LoadBalancer", 
  "title": "SSL cipher group", 
  "type": "string"
}

SslProtocol (type) 

{
  "additionalProperties": false, 
  "enum": [
    "SSL_V2", 
    "SSL_V3", 
    "TLS_V1", 
    "TLS_V1_1", 
    "TLS_V1_2"
  ], 
  "id": "SslProtocol", 
  "module_id": "LoadBalancer", 
  "title": "SSL protocol", 
  "type": "string"
}

StandardHostSwitch (type) 

{
  "id": "StandardHostSwitch", 
  "module_id": "TransportNode", 
  "properties": {
    "cpu_config": {
      "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.", 
      "items": {
        "$ref": "CpuCoreConfigForEnhancedNetworkingStackSwitch"+
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Enhanced Networking Stack enabled HostSwitch CPU configuration", 
      "type": "array"
    }, 
    "host_switch_name": {
      "default": "nsxDefaultHostSwitch", 
      "description": "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.", 
      "required": false, 
      "title": "host switch name. This name will be used to reference this host switch.", 
      "type": "string"
    }, 
    "host_switch_profile_ids": {
      "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.", 
      "items": {
        "$ref": "HostSwitchProfileTypeIdEntry"+
      }, 
      "required": false, 
      "title": "Identifiers of host switch profiles to be associated with this host switch.", 
      "type": "array"
    }, 
    "ip_assignment_spec": {
      "$ref": "IpAssignmentSpec"+, 
      "description": "IPs can come from either a static IP pool or an explicitly specified IP list or DHCP. In case a list of IP is specified, the number of IPs provided should be sufficient as per teaming policy associated with host switch uplink profile.", 
      "readonly": false, 
      "required": false, 
      "title": "Specification for IPs to be used with host switch virtual tunnel endpoints"
    }, 
    "pnics": {
      "items": {
        "$ref": "Pnic"+
      }, 
      "required": false, 
      "title": "Physical NICs connected to the host switch", 
      "type": "array"
    }
  }, 
  "title": "Standard host switch specification", 
  "type": "object"
}

StandardHostSwitchSpec (type) 

{
  "description": "Standard host switch specification is used for NSX configured transport node.", 
  "extends": {
    "$ref": "HostSwitchSpec"+
  }, 
  "id": "StandardHostSwitchSpec", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "StandardHostSwitchSpec"
  }, 
  "properties": {
    "host_switches": {
      "items": {
        "$ref": "StandardHostSwitch"+
      }, 
      "maxItems": 5, 
      "minItems": 0, 
      "required": true, 
      "title": "Transport Node host switches", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "StandardHostSwitchSpec", 
        "PreconfiguredHostSwitchSpec"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Specification of transport node standard host switch", 
  "type": "object"
}

StatItem (type) 

{
  "additionalProperties": false, 
  "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.", 
  "id": "StatItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "drilldown_id": {
      "description": "Id of drilldown widget, if any. Id should be a valid id of an existing widget.", 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "tooltip": {
      "description": "Multi-line text to be shown on tooltip while hovering over the stat.", 
      "items": {
        "$ref": "Tooltip"+
      }, 
      "minItems": 0, 
      "title": "Multi-line tooltip", 
      "type": "array"
    }, 
    "value": {
      "description": "Expression for stat to be displayed.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Stat", 
      "type": "string"
    }
  }, 
  "title": "Statistic of an entity", 
  "type": "object"
}

StaticHopBfdPeer (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "StaticHopBfdPeer", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "bfd_config": {
      "$ref": "BfdConfigParameters"+, 
      "description": "If not specified then BFD peer will inherit configuration from the BFD global config.", 
      "required": false, 
      "title": "Configuration for the BFD peer"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "description": "Indicate BFD peer is enabled or disabled. Default is true.", 
      "required": false, 
      "title": "status of BFD peer", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "peer_ip_address": {
      "$ref": "IPv4Address"+, 
      "description": "IP address of BFD peer. This should be same as next hop IP address.", 
      "required": true, 
      "title": "IP address of BFD peer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "source_addresses": {
      "description": "BFD peers will be created from all these source addresses to this neighbour.", 
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 1, 
      "required": false, 
      "title": "Array of Logical Router Uplink IP Addresses", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

StaticHopBfdPeerListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "StaticHopBfdPeerListParameters", 
  "module_id": "Routing", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "BFD Peers list parameters", 
  "type": "object"
}

StaticHopBfdPeerListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "StaticHopBfdPeerListResult", 
  "module_id": "Routing", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "StaticHopBfdPeer"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "static hop BFD peer list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

StaticIpListSpec (type) 

{
  "extends": {
    "$ref": "IpAssignmentSpec"+
  }, 
  "id": "StaticIpListSpec", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "StaticIpListSpec"
  }, 
  "properties": {
    "default_gateway": {
      "$ref": "IPAddress"+, 
      "readonly": false, 
      "required": true, 
      "title": "Gateway IP"
    }, 
    "ip_list": {
      "items": {
        "$ref": "IPAddress"+
      }, 
      "maxItems": 32, 
      "readonly": false, 
      "required": true, 
      "title": "List of IPs for transport node host switch virtual tunnel endpoints", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "StaticIpPoolSpec", 
        "StaticIpListSpec", 
        "AssignedByDhcp", 
        "StaticIpMacListSpec"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "subnet_mask": {
      "$ref": "IPAddress"+, 
      "readonly": false, 
      "required": true, 
      "title": "Subnet mask"
    }
  }, 
  "title": "IP assignment specification for Static IP List.", 
  "type": "object"
}

StaticIpMacListSpec (type) 

{
  "extends": {
    "$ref": "IpAssignmentSpec"+
  }, 
  "id": "StaticIpMacListSpec", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "StaticIpMacListSpec"
  }, 
  "properties": {
    "default_gateway": {
      "$ref": "IPAddress"+, 
      "readonly": false, 
      "required": true, 
      "title": "Gateway IP"
    }, 
    "ip_mac_list": {
      "items": {
        "$ref": "IpMacPair"+
      }, 
      "maxItems": 32, 
      "readonly": false, 
      "required": true, 
      "title": "List of IPs and MACs for transport node host switch virtual tunnel endpoints", 
      "type": "array"
    }, 
    "resource_type": {
      "enum": [
        "StaticIpPoolSpec", 
        "StaticIpListSpec", 
        "AssignedByDhcp", 
        "StaticIpMacListSpec"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "subnet_mask": {
      "$ref": "IPAddress"+, 
      "readonly": false, 
      "required": true, 
      "title": "Subnet mask"
    }
  }, 
  "title": "IP and MAC assignment specification for Static IP List.", 
  "type": "object"
}

StaticIpPoolSpec (type) 

{
  "extends": {
    "$ref": "IpAssignmentSpec"+
  }, 
  "id": "StaticIpPoolSpec", 
  "module_id": "TransportNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "StaticIpPoolSpec"
  }, 
  "properties": {
    "ip_pool_id": {
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "StaticIpPoolSpec", 
        "StaticIpListSpec", 
        "AssignedByDhcp", 
        "StaticIpMacListSpec"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "IP assignment specification for Static IP Pool.", 
  "type": "object"
}

StaticRoute (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "StaticRoute", 
  "module_id": "Routing", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "logical_router_id": {
      "readonly": true, 
      "required": false, 
      "title": "Logical router id", 
      "type": "string"
    }, 
    "network": {
      "$ref": "IPv4CIDRBlock"+, 
      "required": true, 
      "title": "CIDR"
    }, 
    "next_hops": {
      "items": {
        "$ref": "StaticRouteNextHop"+
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Next Hops", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

StaticRouteListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "StaticRouteListResult", 
  "module_id": "Routing", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "StaticRoute"+
      }, 
      "required": true, 
      "title": "Paginated list of static routes", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

StaticRouteNextHop (type) 

{
  "additionalProperties": false, 
  "id": "StaticRouteNextHop", 
  "module_id": "Routing", 
  "properties": {
    "administrative_distance": {
      "default": 1, 
      "maximum": 255, 
      "minimum": 1, 
      "required": false, 
      "title": "Administrative Distance for the next hop IP", 
      "type": "integer"
    }, 
    "bfd_enabled": {
      "default": false, 
      "readonly": true, 
      "required": false, 
      "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.", 
      "type": "boolean"
    }, 
    "blackhole_action": {
      "$ref": "BlackholeAction"+, 
      "readonly": true, 
      "required": false, 
      "title": "Action to be taken on matching packets for NULL routes."
    }, 
    "ip_address": {
      "$ref": "IPv4Address"+, 
      "required": false, 
      "title": "Next Hop IP"
    }, 
    "logical_router_port_id": {
      "$ref": "ResourceReference"+, 
      "required": false, 
      "title": "Reference of logical router port to be used for next hop"
    }
  }, 
  "type": "object"
}

StatsConfiguration (type) 

{
  "additionalProperties": false, 
  "description": "Represents configuration of a statistic for an entity. Example, number of logical switches and their admin states.", 
  "extends": {
    "$ref": "WidgetConfiguration"+
  }, 
  "id": "StatsConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "StatsConfiguration"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "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.", 
      "items": {
        "$ref": "Datasource"+
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "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.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "footer": {
      "$ref": "Footer"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "label": {
      "$ref": "Label"+, 
      "description": "Displayed at the sections, by default. It labels the entities of sections. If label is not provided, the sections are not labelled.", 
      "title": "Label of the Stats Configuration"
    }, 
    "navigation": {
      "description": "Hyperlink of the specified UI page that provides details.", 
      "maxLength": 1024, 
      "title": "Navigation to a specified UI page", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "sections": {
      "decription": "High level logical grouping of portions or segments.", 
      "items": {
        "$ref": "DonutSection"+
      }, 
      "minItems": 0, 
      "title": "Sections", 
      "type": "array"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "stat": {
      "$ref": "StatItem"+, 
      "description": "Expression that fetches statistic. 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. If stat is not provided, then it will not be displayed.", 
      "title": "Expression for feching statistic of an entity"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Stats Configuration", 
  "type": "object"
}

StatusCount (type) 

{
  "additionalProperties": false, 
  "id": "StatusCount", 
  "module_id": "Heatmap", 
  "properties": {
    "degraded_count": {
      "title": "Degraded count", 
      "type": "int"
    }, 
    "down_count": {
      "title": "Down count", 
      "type": "int"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "title": "Roll-up status", 
      "type": "string"
    }, 
    "up_count": {
      "title": "Up count", 
      "type": "int"
    }
  }, 
  "type": "object"
}

StatusSummaryRequestParameters (type) 

{
  "additionalProperties": false, 
  "id": "StatusSummaryRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "selection_status": {
      "default": "ALL", 
      "enum": [
        "SELECTED", 
        "DESELECTED", 
        "ALL"
      ], 
      "required": false, 
      "title": "Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units", 
      "type": "string"
    }, 
    "show_history": {
      "description": "Get details of the last 16 operations performed during the upgrade of a given component.", 
      "readonly": false, 
      "required": false, 
      "title": "Get upgrade activity for a given component", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

StringMapEntry (type) 

{
  "additionalProperties": false, 
  "id": "StringMapEntry", 
  "module_id": "VCExecuteOperation", 
  "properties": {
    "key": {
      "readonly": false, 
      "required": true, 
      "title": "String key for the map", 
      "type": "string"
    }, 
    "value": {
      "maxLength": 8192, 
      "readonly": false, 
      "required": false, 
      "title": "String value for the map entry", 
      "type": "string"
    }
  }, 
  "type": "object"
}

StructuredData (type) 

{
  "additionalProperties": false, 
  "id": "StructuredData", 
  "properties": {
    "audit": {
      "required": true, 
      "title": "Audit flag of the log", 
      "type": "string"
    }, 
    "comp": {
      "required": true, 
      "title": "Component value of the log", 
      "type": "string"
    }, 
    "ent_id": {
      "required": false, 
      "title": "Entity Id value of the log", 
      "type": "string"
    }, 
    "ereq_id": {
      "required": false, 
      "title": "External request Id value of the log", 
      "type": "string"
    }, 
    "error_code": {
      "required": false, 
      "title": "Error Code value of the log", 
      "type": "string"
    }, 
    "level": {
      "required": false, 
      "title": "Level value of the log", 
      "type": "string"
    }, 
    "req_id": {
      "required": false, 
      "title": "Request Id value of the log", 
      "type": "string"
    }, 
    "s2comp": {
      "required": false, 
      "title": "Sub-subcomponent value of the log", 
      "type": "string"
    }, 
    "security": {
      "required": false, 
      "title": "Security flag of the log", 
      "type": "string"
    }, 
    "subcomp": {
      "required": true, 
      "title": "Subcomponent value of the log", 
      "type": "string"
    }, 
    "username": {
      "required": false, 
      "title": "Username value of the log", 
      "type": "string"
    }
  }, 
  "title": "Structured data entry in RFC5424 log format", 
  "type": "object"
}

SuccessNodeSupportBundleResult (type) 

{
  "additionalProperties": false, 
  "id": "SuccessNodeSupportBundleResult", 
  "properties": {
    "bundle_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of support bundle, e.g. nsx_NODETYPE_UUID_YYYYMMDD_HHMMSS.tgz", 
      "type": "string"
    }, 
    "bundle_size": {
      "readonly": true, 
      "required": true, 
      "title": "Size of support bundle in bytes", 
      "type": "integer"
    }, 
    "node_display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Display name of node", 
      "type": "string"
    }, 
    "node_id": {
      "readonly": true, 
      "required": true, 
      "title": "UUID of node", 
      "type": "string"
    }, 
    "sha256_thumbprint": {
      "readonly": true, 
      "required": true, 
      "title": "File's SHA256 thumbprint", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SummaryRequest (type) 

{
  "additionalProperties": false, 
  "id": "SummaryRequest", 
  "module_id": "Upgrade", 
  "properties": {
    "summary": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag indicating whether to return the summary", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

SupportBundleFileTransferAuthenticationScheme (type) 

{
  "additionalProperties": false, 
  "id": "SupportBundleFileTransferAuthenticationScheme", 
  "properties": {
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password to authenticate with", 
      "type": "string"
    }, 
    "scheme_name": {
      "enum": [
        "PASSWORD"
      ], 
      "required": true, 
      "title": "Authentication scheme name", 
      "type": "string"
    }, 
    "username": {
      "required": true, 
      "title": "User name to authenticate with", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SupportBundleFileTransferProtocol (type) 

{
  "additionalProperties": false, 
  "id": "SupportBundleFileTransferProtocol", 
  "properties": {
    "authentication_scheme": {
      "$ref": "SupportBundleFileTransferAuthenticationScheme"+, 
      "required": true, 
      "title": "Scheme to authenticate if required"
    }, 
    "name": {
      "enum": [
        "SCP", 
        "SFTP"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SupportBundleQueryParameter (type) 

{
  "additionalProperties": false, 
  "id": "SupportBundleQueryParameter", 
  "properties": {
    "override_async_response": {
      "default": false, 
      "description": "Override an existing support bundle async response if it exists. If not set to true and an existing async response is available, the support bundle request results in 409 CONFLICT.", 
      "title": "Override any existing support bundle async response", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

SupportBundleQueryParameters (type) 

{
  "additionalProperties": false, 
  "id": "SupportBundleQueryParameters", 
  "properties": {
    "all": {
      "default": false, 
      "description": "Include all files including files that may have sensitive information like core files.", 
      "title": "Include all files", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

SupportBundleRemoteFileServer (type) 

{
  "additionalProperties": false, 
  "id": "SupportBundleRemoteFileServer", 
  "properties": {
    "directory_path": {
      "required": true, 
      "title": "Remote server directory to copy bundle files to", 
      "type": "string"
    }, 
    "manager_upload_only": {
      "default": false, 
      "title": "Uploads to the remote file server performed by the manager", 
      "type": "boolean"
    }, 
    "port": {
      "default": 22, 
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "$ref": "SupportBundleFileTransferProtocol"+, 
      "required": true, 
      "title": "Protocol to use to copy file"
    }, 
    "server": {
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }
  }, 
  "title": "Remote file server", 
  "type": "object"
}

SupportBundleRequest (type) 

{
  "additionalProperties": false, 
  "id": "SupportBundleRequest", 
  "properties": {
    "content_filters": {
      "default": [
        "DEFAULT"
      ], 
      "items": {
        "$ref": "ContentFilterValue"+
      }, 
      "minItems": 1, 
      "title": "Bundle should include content of specified type", 
      "type": "array"
    }, 
    "log_age_limit": {
      "minimum": 1, 
      "title": "Include log files with modified times not past the age limit in days", 
      "type": "integer"
    }, 
    "nodes": {
      "items": {
        "type": "string"
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "List of cluster/fabric node UUIDs processed in specified order", 
      "type": "array"
    }, 
    "remote_file_server": {
      "$ref": "SupportBundleRemoteFileServer"+, 
      "title": "Remote file server to copy bundles to, bundle in response body if not specified"
    }
  }, 
  "type": "object"
}

SupportBundleResult (type) 

{
  "additionalProperties": false, 
  "id": "SupportBundleResult", 
  "properties": {
    "failed_nodes": {
      "items": {
        "$ref": "FailedNodeSupportBundleResult"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Nodes where bundles were not generated or not copied to remote server", 
      "type": "array"
    }, 
    "remaining_nodes": {
      "items": {
        "$ref": "RemainingSupportBundleNode"+
      }, 
      "title": "Nodes where bundle generation is pending or in progress", 
      "type": "array"
    }, 
    "request_properties": {
      "$ref": "SupportBundleRequest"+, 
      "readonly": true, 
      "required": true, 
      "title": "Request properties"
    }, 
    "success_nodes": {
      "items": {
        "$ref": "SuccessNodeSupportBundleResult"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Nodes whose bundles were successfully copied to remote file server", 
      "type": "array"
    }
  }, 
  "type": "object"
}

SwitchSecuritySwitchingProfile (type) 

{
  "extends": {
    "$ref": "BaseSwitchingProfile"+
  }, 
  "id": "SwitchSecuritySwitchingProfile", 
  "module_id": "SwitchSecuritySwitchingProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "SwitchSecuritySwitchingProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "block_non_ip_traffic": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "A flag to block all traffic except IP/(G)ARP/BPDU", 
      "type": "boolean"
    }, 
    "bpdu_filter": {
      "$ref": "BpduFilter"+, 
      "description": "BPDU filtering is enabled by default. A pre-defined list of MAC addresses\nare automatically excluded from BPDU filtering.\n", 
      "readonly": false, 
      "required": false, 
      "title": "Enables or disables BPDU filtering"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "dhcp_filter": {
      "$ref": "DhcpFilter"+, 
      "description": "DHCP server blocking is enabled and client blocking is disabled by default", 
      "readonly": false, 
      "required": false, 
      "title": "Filters DHCP server and/or client traffic."
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "rate_limits": {
      "$ref": "RateLimits"+, 
      "description": "Rate limiting is disabled by default", 
      "readonly": false, 
      "required": false, 
      "title": "Allows configuration of rate limits for broadcast and multicast traffic"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'QosSwitchingProfile', 'PortMirroringSwitchingProfile',\n'IpDiscoverySwitchingProfile', 'MacManagementSwitchingProfile', 'SpoofGuardSwitchingProfile' and 'SwitchSecuritySwitchingProfile'\n", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

SwitchingProfileListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "SwitchingProfileListParameters", 
  "module_id": "BaseSwitchingProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_system_owned": {
      "default": false, 
      "required": false, 
      "title": "Whether the list result contains system resources", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "switching_profile_type": {
      "required": false, 
      "title": "comma-separated list of switching profile types, e.g. ?switching_profile_type=QosSwitchingProfile,PortMirroringSwitchingProfile", 
      "type": "string"
    }
  }, 
  "title": "Switching profile list parameters", 
  "type": "object"
}

SwitchingProfileType (type) 

{
  "enum": [
    "QosSwitchingProfile", 
    "PortMirroringSwitchingProfile", 
    "IpDiscoverySwitchingProfile", 
    "SpoofGuardSwitchingProfile", 
    "SwitchSecuritySwitchingProfile", 
    "MacManagementSwitchingProfile"
  ], 
  "id": "SwitchingProfileType", 
  "module_id": "BaseSwitchingProfile", 
  "title": "Supported switching profiles.", 
  "type": "string"
}

SwitchingProfileTypeIdEntry (type) 

{
  "id": "SwitchingProfileTypeIdEntry", 
  "module_id": "BaseSwitchingProfile", 
  "properties": {
    "key": {
      "$ref": "SwitchingProfileType"+
    }, 
    "value": {
      "description": "key value", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

SwitchingProfilesListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "SwitchingProfilesListResult", 
  "module_id": "BaseSwitchingProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "BaseSwitchingProfile"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Switching Profile Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Switching Profile queries result", 
  "type": "object"
}

SwitchingToVmcModeParameters (type) 

{
  "additionalProperties": {}, 
  "description": "Possible values of a mode in a \"/config/nsx_appliance_mode\" file", 
  "extends": {
    "$ref": "NodeMode"+
  }, 
  "id": "SwitchingToVmcModeParameters", 
  "properties": {
    "auth_code": {
      "$ref": "Oauth2Credentials"+, 
      "description": "Client's credentials.", 
      "required": true, 
      "title": "Auth Code"
    }, 
    "base_url": {
      "description": "Protocol and domain name (or IP address) of a CSP server, like \"https://console-stg.cloud.vmware.com\".", 
      "required": true, 
      "title": "CSP base URL", 
      "type": "string"
    }, 
    "csp_client_credential": {
      "$ref": "Oauth2Credentials"+, 
      "description": "Client's credentials on CSP server", 
      "title": "CSP Client Credential"
    }, 
    "csp_client_incoming_credentials": {
      "description": "List of incoming client IDs", 
      "items": {
        "type": "string"
      }, 
      "title": "CSP client incoming credentials", 
      "type": "array"
    }, 
    "csp_org_uri": {
      "description": "Relative path on CSP server to the Org location. Can be \"/csp/gateway/am/api/orgs/\".", 
      "required": true, 
      "title": "Relative path to CSP Org", 
      "type": "string"
    }, 
    "csp_time_drift": {
      "description": "CSP time drift in milliseconds", 
      "title": "CSP time drift", 
      "type": "integer"
    }, 
    "default_org_id": {
      "description": "Org ID of a Client - commonly UUID.", 
      "required": true, 
      "title": "Org ID of a Client", 
      "type": "string"
    }, 
    "ea_org": {
      "$ref": "OrgInfo"+, 
      "description": "Org ID and role of \"Site Reliability Engineer\"", 
      "title": "Org Info for \"Site Reliability Engineer\""
    }, 
    "gss_org": {
      "$ref": "OrgInfo"+, 
      "description": "Org ID and role of \"Global Support Services\"", 
      "title": "Org Info for \"Global Support Services\""
    }, 
    "mode_change_only": {
      "description": "When this parameter is set to true, only a change in the node mode happens without any update to auth properties. The required params would need to provided but they would be ignored in the backed. When this param is not set to true i.e. set to false or not provided, the mode change and auth properties update will both happen.", 
      "title": "Only change node  mode", 
      "type": "boolean"
    }, 
    "mode_id": {
      "description": "Possible enum values in a \"/config/nsx_appliance_mode\" file", 
      "enum": [
        "ON_PREM", 
        "SERVICE", 
        "VMC", 
        "VMC_LOCAL"
      ], 
      "required": true, 
      "title": "Nsx node mode", 
      "type": "string"
    }, 
    "proxy_host": {
      "$ref": "HostnameOrIPv4Address"+, 
      "title": "IP/host of PoP (Point-of-Presence) Http proxy server", 
      "type": "string"
    }, 
    "proxy_port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Port of PoP (Point-of-Presence) Http proxy server", 
      "type": "integer"
    }, 
    "sddc_id": {
      "description": "SDDC id", 
      "title": "SDDC id", 
      "type": "string"
    }, 
    "service_definition_id": {
      "description": "Service definition id", 
      "title": "Service definition id", 
      "type": "string"
    }, 
    "sre_org": {
      "$ref": "OrgInfo"+, 
      "description": "Org ID and role of \"Enterprise Admin\"", 
      "title": "Org Info for \"Enterprise Admin\""
    }
  }, 
  "title": "Parameters required to switch to VMC nsx node mode", 
  "type": "object"
}

SyslogFacility (type) 

{
  "enum": [
    "KERN", 
    "USER", 
    "MAIL", 
    "DAEMON", 
    "AUTH", 
    "SYSLOG", 
    "LPR", 
    "NEWS", 
    "UUCP", 
    "AUTHPRIV", 
    "FTP", 
    "LOGALERT", 
    "CRON", 
    "LOCAL0", 
    "LOCAL1", 
    "LOCAL2", 
    "LOCAL3", 
    "LOCAL4", 
    "LOCAL5", 
    "LOCAL6", 
    "LOCAL7"
  ], 
  "id": "SyslogFacility", 
  "title": "Syslog facility", 
  "type": "string"
}

SystemHostname (type) 

{
  "id": "SystemHostname", 
  "maxLength": 255, 
  "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])?)*\\.?$", 
  "title": "System host name", 
  "type": "string"
}

Tag (type) 

{
  "id": "Tag", 
  "module_id": "Common", 
  "properties": {
    "scope": {
      "default": "", 
      "description": "Tag searches may optionally be restricted by scope", 
      "display": {
        "order": 1
      }, 
      "maxLength": 128, 
      "readonly": false, 
      "title": "Tag scope", 
      "type": "string"
    }, 
    "tag": {
      "default": "", 
      "description": "Identifier meaningful to user", 
      "display": {
        "order": 2
      }, 
      "maxLength": 256, 
      "readonly": false, 
      "title": "Tag value", 
      "type": "string"
    }
  }, 
  "title": "Arbitrary key-value pairs that may be attached to an entity", 
  "type": "object"
}

TargetResourceStatus (type) 

{
  "description": "Holds status of target resource in firewall context.", 
  "id": "TargetResourceStatus", 
  "module_id": "FirewallStatus", 
  "properties": {
    "target_id": {
      "description": "Identifier of the NSX resource.", 
      "maxLength": 64, 
      "readonly": false, 
      "required": false, 
      "title": "Target ID", 
      "type": "string"
    }, 
    "target_status": {
      "$ref": "FirewallStatusType"+, 
      "description": "Firewall status on a target logical resource.", 
      "readonly": false, 
      "required": true, 
      "title": "Firewall Status Type"
    }
  }, 
  "type": "object"
}

TaskListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TaskListResult", 
  "module_id": "Tasks", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TaskProperties"+
      }, 
      "required": true, 
      "title": "Task property results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Task query results", 
  "type": "object"
}

TaskProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "TaskProperties", 
  "module_id": "Common", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "async_response_available": {
      "display": {
        "order": 13
      }, 
      "readonly": true, 
      "title": "True if response for asynchronous request is available", 
      "type": "boolean"
    }, 
    "cancelable": {
      "display": {
        "order": 8
      }, 
      "readonly": true, 
      "title": "True if this task can be canceled", 
      "type": "boolean"
    }, 
    "description": {
      "display": {
        "order": 2
      }, 
      "readonly": true, 
      "title": "Description of the task", 
      "type": "string"
    }, 
    "end_time": {
      "$ref": "EpochMsTimestamp"+, 
      "display": {
        "order": 6
      }, 
      "readonly": true, 
      "title": "The end time of the task in epoch milliseconds"
    }, 
    "id": {
      "display": {
        "order": 1
      }, 
      "readonly": true, 
      "title": "Identifier for this task", 
      "type": "string"
    }, 
    "message": {
      "display": {
        "order": 4
      }, 
      "readonly": true, 
      "title": "A message describing the disposition of the task", 
      "type": "string"
    }, 
    "progress": {
      "display": {
        "order": 7
      }, 
      "maximum": 100, 
      "minimum": 0, 
      "readonly": true, 
      "title": "Task progress if known, from 0 to 100", 
      "type": "integer"
    }, 
    "request_method": {
      "display": {
        "order": 12
      }, 
      "readonly": true, 
      "title": "HTTP request method", 
      "type": "string"
    }, 
    "request_uri": {
      "display": {
        "order": 11
      }, 
      "readonly": true, 
      "title": "URI of the method invocation that spawned this task", 
      "type": "string"
    }, 
    "start_time": {
      "$ref": "EpochMsTimestamp"+, 
      "display": {
        "order": 5
      }, 
      "readonly": true, 
      "title": "The start time of the task in epoch milliseconds"
    }, 
    "status": {
      "$ref": "TaskStatus"+, 
      "display": {
        "order": 3
      }, 
      "readonly": true, 
      "title": "Current status of the task"
    }, 
    "user": {
      "display": {
        "order": 10
      }, 
      "readonly": true, 
      "title": "Name of the user who created this task", 
      "type": "string"
    }
  }, 
  "title": "Task properties", 
  "type": "object"
}

TaskQueryParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "TaskQueryParameters", 
  "module_id": "Tasks", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "request_uri": {
      "description": "Comma-separated request URIs to include in query result", 
      "title": "Request URI(s) to include in query result", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "status": {
      "description": "Comma-separated status values to include in query result", 
      "title": "Status(es) to include in query result", 
      "type": "string"
    }, 
    "user": {
      "description": "Comma-separated user names to include in query result", 
      "title": "Names of users to include in query result", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TaskStatus (type) 

{
  "enum": [
    "running", 
    "error", 
    "success", 
    "canceling", 
    "canceled", 
    "killed"
  ], 
  "id": "TaskStatus", 
  "module_id": "Common", 
  "title": "Current status of the task", 
  "type": "string"
}

TeamingPolicy (type) 

{
  "id": "TeamingPolicy", 
  "module_id": "UplinkHostSwitchProfile", 
  "properties": {
    "active_list": {
      "items": {
        "$ref": "Uplink"+
      }, 
      "required": true, 
      "title": "List of Uplinks used in active list", 
      "type": "array"
    }, 
    "policy": {
      "enum": [
        "FAILOVER_ORDER", 
        "LOADBALANCE_SRCID"
      ], 
      "required": true, 
      "title": "Teaming policy", 
      "type": "string"
    }, 
    "standby_list": {
      "items": {
        "$ref": "Uplink"+
      }, 
      "required": false, 
      "title": "List of Uplinks used in standby list", 
      "type": "array"
    }
  }, 
  "title": "Uplink Teaming Policy", 
  "type": "object"
}

TelemetryAgreement (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "TelemetryAgreement", 
  "module_id": "TelemetryConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "telemetry_agreement_displayed": {
      "description": "Determine if telemetry agreement has been displayed. If false,\nthe agreement text will be displayed at login time.\n", 
      "required": true, 
      "title": "Flag to indicate if telemetry agreement has been displayed", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

TelemetryConfig (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "TelemetryConfig", 
  "module_id": "TelemetryConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "ceip_acceptance": {
      "description": "Enable this flag to participate in the Customer Experience Improvement Program.\n", 
      "required": true, 
      "title": "Flag to indicate if CEIP has been accepted", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "proxy_enabled": {
      "default": false, 
      "description": "Enable this flag to specify a proxy, and provide the proxy settings.", 
      "required": false, 
      "title": "Flag to indicate if proxy has been configured", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "schedule_enabled": {
      "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", 
      "required": true, 
      "title": "Flag to indicate if data collection is enabled", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "telemetry_proxy": {
      "$ref": "TelemetryProxy"+, 
      "description": "Specify the proxy configuration (scheme, server, port) here.", 
      "required": false, 
      "title": "Set config for proxy to be used to send out telemetry data"
    }, 
    "telemetry_schedule": {
      "$ref": "TelemetrySchedule"+, 
      "description": "Specify one of Daily, Weekly or Monthly schedules.", 
      "required": false, 
      "title": "Set schedule for when telemetry data should be collected"
    }
  }, 
  "type": "object"
}

TelemetryProxy (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "TelemetryProxy", 
  "module_id": "TelemetryConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "hostname": {
      "description": "Specify the fully qualified domain name, or ip address, of the proxy server.\n", 
      "format": "hostname-or-ip", 
      "required": true, 
      "title": "FQDN or IP address of the proxy server", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "password": {
      "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", 
      "required": false, 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "port": {
      "description": "Specify the port of the proxy server.", 
      "required": true, 
      "title": "Configured port for proxy", 
      "type": "int"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "scheme": {
      "description": "The scheme accepted by the proxy server. Specify one of HTTP and HTTPS.\n", 
      "enum": [
        "HTTP", 
        "HTTPS"
      ], 
      "required": true, 
      "title": "The scheme accepted by the proxy server", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "username": {
      "description": "Specify the user name used to authenticate with the proxy server, if required.\n", 
      "required": false, 
      "title": "User name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TelemetrySchedule (type) 

{
  "abstract": true, 
  "id": "TelemetrySchedule", 
  "module_id": "TelemetryConfig", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "frequency_type"
  }, 
  "properties": {
    "frequency_type": {
      "description": "Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.", 
      "required": true, 
      "title": "Frequency at which data will be collected", 
      "type": "string"
    }
  }, 
  "title": "Abstract base type for telemetry schedule configuration", 
  "type": "object"
}

Tooltip (type) 

{
  "additionalProperties": false, 
  "description": "Tooltip to be shown while hovering over the dashboard UI element.", 
  "id": "Tooltip", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "condition": {
      "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.", 
      "maxLength": 1024, 
      "title": "Expression for evaluating condition", 
      "type": "string"
    }, 
    "text": {
      "description": "Text to be shown on tooltip while hovering over UI element. The text would be wrapped if it exceeds 80 chars.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Textbox shown at tooltip", 
      "type": "string"
    }
  }, 
  "title": "Tooltip", 
  "type": "object"
}

Traceflow (type) 

{
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "Traceflow", 
  "module_id": "Traceflow", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "analysis": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "Traceflow result analysis notes", 
      "type": "array"
    }, 
    "counters": {
      "$ref": "TraceflowObservationCounters"+, 
      "readonly": true, 
      "required": false, 
      "title": "observation counters"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the traceflow round", 
      "type": "string"
    }, 
    "logical_counters": {
      "$ref": "TraceflowObservationCounters"+, 
      "readonly": true, 
      "required": false, 
      "title": "counters of observations from logical components"
    }, 
    "lport_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the source logical port used for injecting the traceflow packet", 
      "type": "string"
    }, 
    "operation_state": {
      "enum": [
        "IN_PROGRESS", 
        "FINISHED", 
        "FAILED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Represents the traceflow operation state", 
      "type": "string"
    }, 
    "request_status": {
      "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 is not found. DATA_PATH_NOT_READY - The datapath component is not ready to receive request. CONNECTION_ERROR - There is connection error on datapath component.", 
      "enum": [
        "SUCCESS", 
        "TIMEOUT", 
        "SOURCE_PORT_NOT_FOUND", 
        "DATA_PATH_NOT_READY", 
        "CONNECTION_ERROR"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Traceflow request status", 
      "type": "string"
    }, 
    "result_overflowed": {
      "readonly": true, 
      "required": false, 
      "title": "A flag, when set true, indicates some observations were deleted from the result set.", 
      "type": "boolean"
    }, 
    "timeout": {
      "description": "Maximum time (in ms) the management plane will be waiting for this traceflow round.", 
      "maximum": 15000, 
      "minimum": 5000, 
      "readonly": true, 
      "required": false, 
      "title": "Timeout (in ms) for traceflow observations result list", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

TraceflowComponentSubType (type) 

{
  "enum": [
    "LR_TIER0", 
    "LR_TIER1", 
    "LR_VRF_TIER0", 
    "LS_TRANSIT", 
    "UNKNOWN"
  ], 
  "id": "TraceflowComponentSubType", 
  "module_id": "Traceflow", 
  "type": "string"
}

TraceflowComponentType (type) 

{
  "enum": [
    "PHYSICAL", 
    "LR", 
    "LS", 
    "DFW", 
    "BRIDGE", 
    "EDGE_TUNNEL", 
    "EDGE_HOSTSWITCH", 
    "UNKNOWN"
  ], 
  "id": "TraceflowComponentType", 
  "module_id": "Traceflow", 
  "type": "string"
}

TraceflowListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "TraceflowListParameters", 
  "module_id": "Traceflow", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "lport_id": {
      "required": false, 
      "title": "id of the source logical port where the trace flows originated", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Traceflow list parameters", 
  "type": "object"
}

TraceflowListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TraceflowListResult", 
  "module_id": "Traceflow", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "Traceflow"+
      }, 
      "readonly": true, 
      "title": "Traceflow Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Traceflow queries result", 
  "type": "object"
}

TraceflowObservation (type) 

{
  "abstract": true, 
  "id": "TraceflowObservation", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "property-name": "resource_type"
  }, 
  "properties": {
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }
  }, 
  "type": "object"
}

TraceflowObservationCounters (type) 

{
  "id": "TraceflowObservationCounters", 
  "module_id": "Traceflow", 
  "properties": {
    "delivered_count": {
      "description": "Total number of delivered observations for this traceflow round.", 
      "readonly": true, 
      "required": false, 
      "title": "Delivered observation count", 
      "type": "integer"
    }, 
    "dropped_count": {
      "description": "Total number of dropped observations for this round.", 
      "readonly": true, 
      "required": false, 
      "title": "Dropped observation count", 
      "type": "integer"
    }, 
    "forwarded_count": {
      "description": "Total number of forwarded observations for this traceflow round.", 
      "readonly": true, 
      "required": false, 
      "title": "Forwarded observation count", 
      "type": "integer"
    }, 
    "received_count": {
      "description": "Total number of received observations for this traceflow round.", 
      "readonly": true, 
      "required": false, 
      "title": "Received observation count", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

TraceflowObservationDelivered (type) 

{
  "extends": {
    "$ref": "TraceflowObservation"+
  }, 
  "id": "TraceflowObservationDelivered", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationDelivered"
  }, 
  "properties": {
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "lport_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the logical port into which the traceflow packet was delivered", 
      "type": "string"
    }, 
    "lport_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the logical port into which the traceflow packet was delivered", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }, 
    "vlan_id": {
      "$ref": "VlanID"+, 
      "required": false, 
      "title": "VLAN on bridged network"
    }
  }, 
  "type": "object"
}

TraceflowObservationDropped (type) 

{
  "extends": {
    "$ref": "TraceflowObservation"+
  }, 
  "id": "TraceflowObservationDropped", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationDropped"
  }, 
  "properties": {
    "acl_rule_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the acl rule that was applied to drop the traceflow packet", 
      "type": "integer"
    }, 
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "lport_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the logical port at which the traceflow packet was dropped", 
      "type": "string"
    }, 
    "lport_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the logical port at which the traceflow packet was dropped", 
      "type": "string"
    }, 
    "reason": {
      "enum": [
        "ARP_FAIL", 
        "BFD", 
        "DHCP", 
        "FW_RULE", 
        "GENEVE", 
        "GRE", 
        "IFACE", 
        "IP", 
        "IP_REASS", 
        "IPSEC", 
        "IPSEC_VTI", 
        "L2VPN", 
        "L4PORT", 
        "LB", 
        "LROUTER", 
        "LSERVICE", 
        "LSWITCH", 
        "MD_PROXY", 
        "NAT", 
        "NEIGH", 
        "NO_ROUTE", 
        "SERVICE_INSERT", 
        "TTL_ZERO", 
        "TUNNEL", 
        "VXLAN", 
        "VXSTT", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The reason traceflow packet was dropped", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }
  }, 
  "type": "object"
}

TraceflowObservationDroppedLogical (type) 

{
  "extends": {
    "$ref": "TraceflowObservationDropped"+
  }, 
  "id": "TraceflowObservationDroppedLogical", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationDroppedLogical"
  }, 
  "properties": {
    "acl_rule_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the acl rule that was applied to drop the traceflow packet", 
      "type": "integer"
    }, 
    "component_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the component that dropped the traceflow packet.", 
      "type": "string"
    }, 
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "lport_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the logical port at which the traceflow packet was dropped", 
      "type": "string"
    }, 
    "lport_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the logical port at which the traceflow packet was dropped", 
      "type": "string"
    }, 
    "reason": {
      "enum": [
        "ARP_FAIL", 
        "BFD", 
        "DHCP", 
        "FW_RULE", 
        "GENEVE", 
        "GRE", 
        "IFACE", 
        "IP", 
        "IP_REASS", 
        "IPSEC", 
        "IPSEC_VTI", 
        "L2VPN", 
        "L4PORT", 
        "LB", 
        "LROUTER", 
        "LSERVICE", 
        "LSWITCH", 
        "MD_PROXY", 
        "NAT", 
        "NEIGH", 
        "NO_ROUTE", 
        "SERVICE_INSERT", 
        "TTL_ZERO", 
        "TUNNEL", 
        "VXLAN", 
        "VXSTT", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The reason traceflow packet was dropped", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }
  }, 
  "type": "object"
}

TraceflowObservationForwarded (type) 

{
  "extends": {
    "$ref": "TraceflowObservation"+
  }, 
  "id": "TraceflowObservationForwarded", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationForwarded"
  }, 
  "properties": {
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "context": {
      "required": false, 
      "title": "The 64bit tunnel context carried on the wire.", 
      "type": "integer"
    }, 
    "dst_transport_node_id": {
      "description": "This field will not be always available. Use remote_ip_address when this field is not set.", 
      "readonly": true, 
      "required": false, 
      "title": "The id of the transport node to which the traceflow packet is forwarded", 
      "type": "string"
    }, 
    "dst_transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the transport node to which the traceflow packet is forwarded", 
      "type": "string"
    }, 
    "local_ip_address": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "IP address of the source end of the tunnel"
    }, 
    "remote_ip_address": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "IP address of the destination end of the tunnel"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }, 
    "uplink_name": {
      "required": false, 
      "title": "The name of the uplink the traceflow packet is forwarded on", 
      "type": "string"
    }, 
    "vtep_label": {
      "required": false, 
      "title": "The virtual tunnel endpoint label", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

TraceflowObservationForwardedLogical (type) 

{
  "extends": {
    "$ref": "TraceflowObservation"+
  }, 
  "id": "TraceflowObservationForwardedLogical", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationForwardedLogical"
  }, 
  "properties": {
    "acl_rule_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the acl rule that was applied to forward the traceflow packet", 
      "type": "integer"
    }, 
    "component_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the component that forwarded the traceflow packet.", 
      "type": "string"
    }, 
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "dst_component_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the destination component to which the traceflow packet was forwarded.", 
      "type": "string"
    }, 
    "dst_component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the destination component to which the traceflow packet was forwarded.", 
      "type": "string"
    }, 
    "dst_component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the destination component to which the traceflow packet was forwarded."
    }, 
    "lport_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the logical port through which the traceflow packet was forwarded.", 
      "type": "string"
    }, 
    "lport_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the logical port through which the traceflow packet was forwarded.", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }, 
    "vni": {
      "readonly": true, 
      "required": false, 
      "title": "VNI for the logical network on which the traceflow packet was forwarded.", 
      "type": "int"
    }
  }, 
  "type": "object"
}

TraceflowObservationListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "TraceflowObservationListParameters", 
  "module_id": "Traceflow", 
  "properties": {
    "component_name": {
      "description": "Observations of all component names will be listed if not given.", 
      "required": false, 
      "title": "Observations having the given component name will be listed.", 
      "type": "string"
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "description": "Observations of all component types will be listed if not given.", 
      "required": false, 
      "title": "Observations having the given component type will be listed."
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "description": "Prefix matching; e.g. TraceflowObservationReceived will also matches TraceflowObservationReceivedLogical. Observations of all types will be listed if not given.", 
      "required": false, 
      "title": "The type of observations that will be listed."
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_name": {
      "description": "Observations of all transport node names will be listed if not given.", 
      "required": false, 
      "title": "Observations having the given transport node name will be listed.", 
      "type": "string"
    }
  }, 
  "title": "Traceflow Observation list parameters", 
  "type": "object"
}

TraceflowObservationListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TraceflowObservationListResult", 
  "module_id": "Traceflow", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TraceflowObservation"+
      }, 
      "required": false, 
      "title": "TraceflowObservation list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TraceflowObservationReceived (type) 

{
  "extends": {
    "$ref": "TraceflowObservation"+
  }, 
  "id": "TraceflowObservationReceived", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationReceived"
  }, 
  "properties": {
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "local_ip_address": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "IP address of the destination end of the tunnel"
    }, 
    "remote_ip_address": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "IP address of the source end of the tunnel"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }, 
    "uplink_name": {
      "required": false, 
      "title": "The name of the uplink the traceflow packet is received on", 
      "type": "string"
    }, 
    "vtep_label": {
      "required": false, 
      "title": "The virtual tunnel endpoint label", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

TraceflowObservationReceivedLogical (type) 

{
  "extends": {
    "$ref": "TraceflowObservation"+
  }, 
  "id": "TraceflowObservationReceivedLogical", 
  "module_id": "Traceflow", 
  "polymorphic-type-descriptor": {
    "type-identifier": "TraceflowObservationReceivedLogical"
  }, 
  "properties": {
    "component_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the component that received the traceflow packet.", 
      "type": "string"
    }, 
    "component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the component that issued the observation.", 
      "type": "string"
    }, 
    "component_sub_type": {
      "$ref": "TraceflowComponentSubType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The sub type of the component that issued the observation."
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the component that issued the observation."
    }, 
    "lport_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the logical port at which the traceflow packet was received", 
      "type": "string"
    }, 
    "lport_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of the logical port at which the traceflow packet was received", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType"+, 
      "default": "TraceflowObservationReceived", 
      "required": true
    }, 
    "sequence_no": {
      "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.", 
      "readonly": true, 
      "required": true, 
      "title": "the sequence number is the traceflow observation hop count", 
      "type": "integer"
    }, 
    "src_component_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the source component from which the traceflow packet was received.", 
      "type": "string"
    }, 
    "src_component_name": {
      "readonly": true, 
      "required": false, 
      "title": "The name of source component from which the traceflow packet was received.", 
      "type": "string"
    }, 
    "src_component_type": {
      "$ref": "TraceflowComponentType"+, 
      "readonly": true, 
      "required": false, 
      "title": "The type of the source component from which the traceflow packet was received."
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the observation was created by the transport node (milliseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node"
    }, 
    "timestamp_micro": {
      "description": "Timestamp when the observation was created by the transport node (microseconds epoch)", 
      "readonly": true, 
      "required": false, 
      "title": "Timestamp when the observation was created by the transport node", 
      "type": "integer"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_name": {
      "readonly": true, 
      "required": false, 
      "title": "name of the transport node that observed a traceflow packet", 
      "type": "string"
    }, 
    "transport_node_type": {
      "$ref": "TransportNodeType"+, 
      "readonly": true, 
      "required": false, 
      "title": "type of the transport node that observed a traceflow packet"
    }, 
    "vni": {
      "readonly": true, 
      "required": false, 
      "title": "VNI for the logical network on which the traceflow packet was received.", 
      "type": "int"
    }
  }, 
  "type": "object"
}

TraceflowObservationType (type) 

{
  "enum": [
    "TraceflowObservationForwarded", 
    "TraceflowObservationDropped", 
    "TraceflowObservationDelivered", 
    "TraceflowObservationReceived", 
    "TraceflowObservationForwardedLogical", 
    "TraceflowObservationDroppedLogical", 
    "TraceflowObservationReceivedLogical"
  ], 
  "id": "TraceflowObservationType", 
  "module_id": "Traceflow", 
  "type": "string"
}

TransportNode (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "TransportNode", 
  "module_id": "TransportNode", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "host_switch_spec": {
      "$ref": "HostSwitchSpec"+, 
      "description": "This property is used to either create standard host switches\nor to inform NSX about preconfigured host switches that already\nexist on the transport node.\n\nPass an array of either StandardHostSwitchSpec objects or\nPreconfiguredHostSwitchSpec objects. It is an error to pass\nan array containing different types of HostSwitchSpec objects.\n", 
      "required": false, 
      "title": "Transport node host switch specification"
    }, 
    "host_switches": {
      "deprecated": true, 
      "description": "This property is deprecated in favor of 'host_switch_spec'. Property 'host_switches' can only be used for NSX managed transport nodes. 'host_switch_spec' can be used for both NSX managed or manually preconfigured host switches.", 
      "items": {
        "$ref": "HostSwitch"+
      }, 
      "required": false, 
      "title": "Transport Node switch(s). Prefer host_switch_spec over this.", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "maintenance_mode": {
      "description": "The property is read-only, used for querying result. User could update transport node maintenance mode by UpdateTransportNodeMaintenanceMode call.", 
      "enum": [
        "ENABLED", 
        "FORCE_ENABLED", 
        "DISABLED"
      ], 
      "readonly": true, 
      "title": "transport node maintenance mode desired state", 
      "type": "string"
    }, 
    "node_id": {
      "required": true, 
      "title": "Unique Id of the fabric node", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zone_endpoints": {
      "items": {
        "$ref": "TransportZoneEndPoint"+
      }, 
      "required": false, 
      "title": "Transport zone endpoints.", 
      "type": "array"
    }
  }, 
  "title": "Transport Node", 
  "type": "object"
}

TransportNodeIdParameters (type) 

{
  "extends": {
    "$ref": "DataSourceParameters"+
  }, 
  "id": "TransportNodeIdParameters", 
  "module_id": "AggSvcL2Types", 
  "properties": {
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "TransportNode Id", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TransportNodeListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "TransportNodeListParameters", 
  "module_id": "TransportNode", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "in_maintenance_mode": {
      "description": "If the flag is true, transport node with 'ENABLED' or 'FORCE_ENABLED' desired state will be returned, otherwise transport nodes in 'DISABLED' will be returned.", 
      "required": false, 
      "title": "maintenance mode flag", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "node_id": {
      "description": "This property can be used by itself or along with 'transport_zone_id'.", 
      "required": false, 
      "title": "node identifier", 
      "type": "string"
    }, 
    "node_ip": {
      "description": "This property can only be used alone. It can not be combined with other filtering properties.", 
      "required": false, 
      "title": "Fabric node IP address", 
      "type": "string"
    }, 
    "node_types": {
      "description": "The fabric node type is the resource_type of the Node such as HostNode, EdgeNode and PublicCloudGatewayNode. If a list of fabric node types are given, all transport nodes of all given types will be returned.", 
      "required": false, 
      "title": "a list of fabric node types separated by comma or a single type", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_zone_id": {
      "description": "This propery can be used along with 'node_id'.", 
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }
  }, 
  "title": "Transport Node list parameters", 
  "type": "object"
}

TransportNodeListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TransportNodeListResult", 
  "module_id": "TransportNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TransportNode"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "TransportNode Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport Node queries result", 
  "type": "object"
}

TransportNodeReportParameters (type) 

{
  "extends": {
    "$ref": "DataSourceParameters"+
  }, 
  "id": "TransportNodeReportParameters", 
  "module_id": "Heatmap", 
  "properties": {
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED"
      ], 
      "title": "Transport node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TransportNodeState (type) 

{
  "extends": {
    "$ref": "ConfigurationState"+
  }, 
  "id": "TransportNodeState", 
  "module_id": "TransportNode", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "host_switch_states": {
      "items": {
        "$ref": "HostSwitchState"+
      }, 
      "readonly": true, 
      "title": "States of HostSwitches on the host", 
      "type": "array"
    }, 
    "maintenance_mode_state": {
      "$ref": "MaintenanceModeState"+, 
      "readonly": true, 
      "title": "the present realized maintenance mode state"
    }, 
    "state": {
      "description": "Gives details of state of desired configuration", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "title": "Unique Id of the TransportNode", 
      "type": "string"
    }
  }, 
  "title": "Transport Node State", 
  "type": "object"
}

TransportNodeStateListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TransportNodeStateListResult", 
  "module_id": "TransportNode", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TransportNodeState"+
      }, 
      "readonly": true, 
      "title": "Transport Node State Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport node state queries result", 
  "type": "object"
}

TransportNodeStatus (type) 

{
  "additionalProperties": false, 
  "id": "TransportNodeStatus", 
  "module_id": "Heatmap", 
  "properties": {
    "control_connection_status": {
      "$ref": "StatusCount"+, 
      "title": "Control connection status"
    }, 
    "mgmt_connection_status": {
      "enum": [
        "UP", 
        "DOWN"
      ], 
      "title": "Management connection status", 
      "type": "string"
    }, 
    "node_display_name": {
      "description": "Transport node display name", 
      "title": "Display name", 
      "type": "string"
    }, 
    "node_uuid": {
      "title": "Transport node uuid", 
      "type": "string"
    }, 
    "pnic_status": {
      "$ref": "StatusCount"+, 
      "title": "pNIC status"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "title": "Roll-up status of pNIC, management connection, control connection, tunnel status", 
      "type": "string"
    }, 
    "tunnel_status": {
      "$ref": "TunnelStatusCount"+, 
      "title": "Tunnel Status"
    }
  }, 
  "type": "object"
}

TransportNodeStatusListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TransportNodeStatusListResult", 
  "module_id": "Heatmap", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TransportNodeStatus"+
      }, 
      "title": "List of transport node statuses", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TransportNodeStatusParametersWithDataSource (type) 

{
  "extends": {
    "$ref": "ListWithDataSourceParameters"+
  }, 
  "id": "TransportNodeStatusParametersWithDataSource", 
  "module_id": "Heatmap", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "source": {
      "$ref": "DataSourceType"+, 
      "required": false, 
      "title": "The data source, either realtime or cached. If not provided, cached data is returned."
    }, 
    "status": {
      "description": "Rolled-up status of pNIC, management connection, control connection, and tunnel status. UP means all of these are up; DOWN represents the state when pNIC status is down. DEGRADED status here represents the state for a node when its pNIC bond status is DEGRADED, or, its Control connection status is either DEGRADED or DOWN. UNKNOWN is the case when both control connection and tunnel status are unknown. If none of these conditions are true, the node status is considered DOWN.", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "title": "Transport node", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TransportNodeTemplateListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TransportNodeTemplateListResult", 
  "module_id": "TransportNode", 
  "nsx_feature": "AutoTn", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "ComputeCollectionTransportNodeTemplate"+
      }, 
      "readonly": true, 
      "title": "Compute collection transport node template results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Compute collection transport node template list result", 
  "type": "object"
}

TransportNodeTemplateState (type) 

{
  "additionalProperties": false, 
  "id": "TransportNodeTemplateState", 
  "module_id": "TransportNode", 
  "nsx_feature": "AutoTn", 
  "properties": {
    "node_id": {
      "required": true, 
      "title": "node id", 
      "type": "string"
    }, 
    "state": {
      "description": "Transport node template state on individual hosts of ComputeCollection\nwhich enabled automated transport code creation.\n'FAILED_TO_CREATE' means transport node isn't created. 'IN_PROGRESS' means\ntransport node is in progress of creation. 'FAILED_TO_REALIZE' means\ntransport node has been created, but failed on host realization, it will\nrepush to host by NSX later. 'SUCCESS' means transport node creation is\nsucceeded.\n", 
      "enum": [
        "FAILED_TO_CREATE", 
        "IN_PROGRESS", 
        "FAILED_TO_REALIZE", 
        "SUCCESS"
      ], 
      "readonly": true, 
      "title": "Application state of transport node template on this host", 
      "type": "string"
    }, 
    "transport_node_id": {
      "required": false, 
      "title": "transport node id", 
      "type": "string"
    }
  }, 
  "title": "transport node template application state", 
  "type": "object"
}

TransportNodeTemplateStateParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "TransportNodeTemplateStateParameters", 
  "module_id": "TransportNode", 
  "nsx_feature": "AutoTn", 
  "properties": {
    "compute_collection_id": {
      "required": false, 
      "title": "Compute collection id", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport node template state parameters", 
  "type": "object"
}

TransportNodeType (type) 

{
  "enum": [
    "ESX", 
    "RHELKVM", 
    "UBUNTUKVM", 
    "EDGE", 
    "PUBLIC_CLOUD_GATEWAY_NODE", 
    "OTHERS", 
    "HYPERV"
  ], 
  "id": "TransportNodeType", 
  "module_id": "Traceflow", 
  "type": "string"
}

TransportType (type) 

{
  "enum": [
    "OVERLAY", 
    "VLAN"
  ], 
  "id": "TransportType", 
  "module_id": "Switching", 
  "type": "string"
}

TransportZone (type) 

{
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "TransportZone", 
  "module_id": "TransportZone", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "host_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "the host switch id generated by the system.", 
      "type": "string"
    }, 
    "host_switch_mode": {
      "default": "STANDARD", 
      "description": "STANDARD mode applies to all the hypervisors. ENS mode stands for Enhanced Networking Stack. This feature is only available for ESX hypervisor. It is not available on KVM, EDGE and Public Cloud Gateway etc. When a Transport Zone mode is set to ENS, only Transport Nodes of type ESX can participate in such a Transport Zone.", 
      "enum": [
        "STANDARD", 
        "ENS"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Operational mode of Transport Zone.", 
      "type": "string"
    }, 
    "host_switch_name": {
      "default": "nsxDefaultHostSwitch", 
      "description": "If this name is unset or empty then the default host switch name will be used.", 
      "required": false, 
      "title": "Name of the host switch on all transport nodes in this transport zone that will be used to run NSX network traffic.", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "nested_nsx": {
      "default": false, 
      "description": "The flag only need to be set in nested NSX environment.", 
      "required": false, 
      "title": "Flag to indicate if transport nodes in this transport zone are connected through nested NSX.", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "$ref": "TransportType"+, 
      "required": true, 
      "title": "The transport type of this transport zone."
    }, 
    "transport_zone_profile_ids": {
      "items": {
        "$ref": "TransportZoneProfileTypeIdEntry"+
      }, 
      "required": false, 
      "title": "Identifiers of the transport zone profiles associated with this TransportZone.", 
      "type": "array"
    }, 
    "uplink_teaming_policy_names": {
      "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.", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Names of the switching uplink teaming policies that are supported by this transport zone.", 
      "type": "array"
    }
  }, 
  "type": "object"
}

TransportZoneEndPoint (type) 

{
  "description": "Specify which HostSwitch from this TransportNode is used handle traffic for given TransportZone", 
  "id": "TransportZoneEndPoint", 
  "module_id": "TransportNode", 
  "properties": {
    "transport_zone_id": {
      "required": true, 
      "title": "Unique ID identifying the transport zone for this endpoint", 
      "type": "string"
    }, 
    "transport_zone_profile_ids": {
      "items": {
        "$ref": "TransportZoneProfileTypeIdEntry"+
      }, 
      "required": false, 
      "title": "Identifiers of the transport zone profiles associated with this transport zone endpoint on this transport node.", 
      "type": "array"
    }
  }, 
  "title": "This object associates TransportNode to a certain TransportZone", 
  "type": "object"
}

TransportZoneInfo (type) 

{
  "additionalProperties": false, 
  "id": "TransportZoneInfo", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "is_underlay_transport_zone": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is the underlay transport zone", 
      "type": "boolean"
    }, 
    "logical_switches": {
      "items": {
        "$ref": "LogicalSwitchInfo"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Logical switches for the transport zone", 
      "type": "array"
    }, 
    "transport_zone_display_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the transport zone", 
      "type": "string"
    }, 
    "transport_zone_id": {
      "readonly": true, 
      "required": false, 
      "title": "ID of the transport zone", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TransportZoneListParameters (type) 

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "TransportZoneListParameters", 
  "module_id": "TransportZone", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "uplink_teaming_policy_name": {
      "description": "All transport zone's with the specified uplink teaming policy name. Otherwise, transport zones with any uplink teaming policy will be returned.", 
      "required": false, 
      "title": "The transport zone's uplink teaming policy name", 
      "type": "string"
    }
  }, 
  "title": "Transport Zone list parameters", 
  "type": "object"
}

TransportZoneListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TransportZoneListResult", 
  "module_id": "TransportZone", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TransportZone"+
      }, 
      "required": true, 
      "title": "Transport Zone Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport zone queries result", 
  "type": "object"
}

TransportZoneProfile (type) 

{
  "abstract": true, 
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "TransportZoneProfile", 
  "module_id": "TransportZoneProfile", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "BfdHealthMonitoringProfile"
      ], 
      "help_summary": "Possible value is 'BfdHealthMonitoringProfile'", 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

TransportZoneProfileListParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "TransportZoneProfileListParameters", 
  "module_id": "TransportZoneProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "include_system_owned": {
      "default": false, 
      "required": false, 
      "title": "Whether the list result contains system resources", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "required": false, 
      "title": "comma-separated list of transport zone profile types, e.g. ?resource_type=BfdHealthMonitoringProfile", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport zone profile list parameters", 
  "type": "object"
}

TransportZoneProfileListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TransportZoneProfileListResult", 
  "module_id": "TransportZoneProfile", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TransportZoneProfile"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Transport zone profile results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport zone profile queries result", 
  "type": "object"
}

TransportZoneProfileType (type) 

{
  "enum": [
    "BfdHealthMonitoringProfile"
  ], 
  "id": "TransportZoneProfileType", 
  "module_id": "TransportZoneProfile", 
  "title": "Supported transport zone profiles.", 
  "type": "string"
}

TransportZoneProfileTypeIdEntry (type) 

{
  "additionalProperties": false, 
  "id": "TransportZoneProfileTypeIdEntry", 
  "module_id": "TransportZoneProfile", 
  "properties": {
    "profile_id": {
      "description": "profile id of the resource type", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "TransportZoneProfileType"+, 
      "description": "Selects the type of the transport zone profile"
    }
  }, 
  "type": "object"
}

TransportZoneStatus (type) 

{
  "id": "TransportZoneStatus", 
  "module_id": "TransportZone", 
  "properties": {
    "num_logical_ports": {
      "readonly": true, 
      "required": true, 
      "title": "Count of logical ports in the transport zone", 
      "type": "int"
    }, 
    "num_logical_switches": {
      "readonly": true, 
      "required": true, 
      "title": "Count of logical switches in the transport zone", 
      "type": "int"
    }, 
    "num_transport_nodes": {
      "readonly": true, 
      "required": true, 
      "title": "Count of transport nodes in the transport zone", 
      "type": "int"
    }, 
    "transport_zone_id": {
      "readonly": true, 
      "required": true, 
      "title": "Unique ID identifying the transport zone", 
      "type": "string"
    }
  }, 
  "title": "Transport zone runtime status information", 
  "type": "object"
}

TransportZoneStatusListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TransportZoneStatusListResult", 
  "module_id": "TransportZone", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "TransportZoneStatus"+
      }, 
      "required": true, 
      "title": "Transport Zone Runtime Status Info Results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Transport zone runtime status queries result", 
  "type": "object"
}

TrunkVlanRange (type) 

{
  "id": "TrunkVlanRange", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "end": {
      "$ref": "VlanID"+, 
      "required": true
    }, 
    "start": {
      "$ref": "VlanID"+, 
      "required": true
    }
  }, 
  "title": "Trunk VLAN id range", 
  "type": "object"
}

TrustManagementData (type) 

{
  "additionalProperties": false, 
  "id": "TrustManagementData", 
  "module_id": "CertificateManager", 
  "properties": {
    "supported_algorithms": {
      "description": "list of supported algorithms", 
      "items": {
        "$ref": "CryptoAlgorithm"+
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

TrustObjectData (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "TrustObjectData", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "key_algo": {
      "description": "Key algorithm contained in this certificate", 
      "type": "string"
    }, 
    "passphrase": {
      "description": "Password for private key encryption", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "type": "string"
    }, 
    "pem_encoded": {
      "description": "pem encoded certificate data", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "private_key": {
      "description": "private key data", 
      "readonly": false, 
      "required": false, 
      "sensitive": true, 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

TunnelDigestAlgorithm (type) 

{
  "additionalProperties": false, 
  "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"
  ], 
  "id": "TunnelDigestAlgorithm", 
  "module_id": "IPSecVPN", 
  "title": "Digest Algorithms used in tunnel establishment", 
  "type": "string"
}

TunnelEncryptionAlgorithm (type) 

{
  "additionalProperties": false, 
  "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_GCM stands for Advanced Encryption Standard(AES)\nin Galois/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"
  ], 
  "id": "TunnelEncryptionAlgorithm", 
  "module_id": "IPSecVPN", 
  "title": "Encryption algorithm used in tunnel", 
  "type": "string"
}

TunnelList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "TunnelList", 
  "module_id": "Tunnel", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "tunnels": {
      "items": {
        "$ref": "TunnelProperties"+
      }, 
      "readonly": true, 
      "title": "List of transport node tunnels", 
      "type": "array"
    }
  }, 
  "type": "object"
}

TunnelPortConfig (type) 

{
  "additionalProperties": false, 
  "description": "IP Tunnel port configuration.", 
  "id": "TunnelPortConfig", 
  "module_id": "IPSecVPN", 
  "properties": {
    "ip_subnets": {
      "description": "IP Tunnel port  (commonly referred as VTI) subnet.", 
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "required": true, 
      "title": "IP Tunnel port subnet", 
      "type": "array"
    }, 
    "tunnel_port_id": {
      "description": "Logical route port identifier.", 
      "readonly": true, 
      "title": "Logical route port identifier", 
      "type": "string"
    }
  }, 
  "title": "IP Tunnel port configuration", 
  "type": "object"
}

TunnelProperties (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "TunnelProperties", 
  "module_id": "Tunnel", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "bfd": {
      "$ref": "BFDProperties"+, 
      "readonly": true, 
      "required": false, 
      "title": "Detailed information about BFD configured on interface"
    }, 
    "egress_interface": {
      "description": "Corresponds to the interface where local_ip_address is routed.", 
      "readonly": true, 
      "required": false, 
      "title": "Name of local transport interface carrying tunnel traffic", 
      "type": "string"
    }, 
    "encap": {
      "enum": [
        "STT", 
        "VXLAN", 
        "GENEVE", 
        "UNKNOWN_ENCAP"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Tunnel encap", 
      "type": "string"
    }, 
    "last_updated_time": {
      "$ref": "EpochMsTimestamp"+, 
      "readonly": true, 
      "required": false, 
      "title": "Time at which the Tunnel status has been fetched last time."
    }, 
    "local_ip": {
      "format": "ip", 
      "readonly": true, 
      "required": false, 
      "title": "Local IP address of tunnel", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of tunnel", 
      "type": "string"
    }, 
    "remote_ip": {
      "format": "ip", 
      "readonly": true, 
      "required": false, 
      "title": "Remote IP address of tunnel", 
      "type": "string"
    }, 
    "remote_node_display_name": {
      "description": "Represents the display name of the remote transport node at the other end of the tunnel.", 
      "readonly": true, 
      "title": "Display name of the remote transport node", 
      "type": "string"
    }, 
    "remote_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "UUID of the remote transport node", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Status of tunnel", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TunnelStatusCount (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "StatusCount"+
  }, 
  "id": "TunnelStatusCount", 
  "module_id": "Heatmap", 
  "properties": {
    "bfd_diagnostic": {
      "$ref": "BFDDiagnosticCount"+, 
      "title": "BFD Diagnostic"
    }, 
    "bfd_status": {
      "$ref": "BFDStatusCount"+, 
      "title": "BFD Status"
    }, 
    "degraded_count": {
      "title": "Degraded count", 
      "type": "int"
    }, 
    "down_count": {
      "title": "Down count", 
      "type": "int"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "title": "Roll-up status", 
      "type": "string"
    }, 
    "up_count": {
      "title": "Up count", 
      "type": "int"
    }
  }, 
  "type": "object"
}

TypeGroup (type) 

{
  "additionalProperties": false, 
  "id": "TypeGroup", 
  "module_id": "Search", 
  "properties": {
    "count": {
      "required": true, 
      "title": "Total count per group by field value", 
      "type": "integer"
    }, 
    "group_by_field_value": {
      "required": true, 
      "title": "Group By Field Value", 
      "type": "string"
    }, 
    "hits": {
      "items": {
        "type": "object"
      }, 
      "required": false, 
      "title": "Hits per resource type", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UnassociatedVMListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UnassociatedVMListResult", 
  "module_id": "GroupingObjectsProviders", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "List of VMs which are not associated with any NSGroup\n", 
      "items": {
        "$ref": "VirtualMachine"+
      }, 
      "required": true, 
      "title": "Unassociated Vitual Machine list results\n", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpdatePrincipalIdentityCertificateRequest (type) 

{
  "additionalProperties": false, 
  "description": "Request to update the certificate of a principal identity with a new\ncertificate\n", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "UpdatePrincipalIdentityCertificateRequest", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "certificate_id": {
      "description": "Id of the stored certificate", 
      "pattern": "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$", 
      "readonly": false, 
      "required": true, 
      "title": "Id of the stored certificate", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "principal_identity_id": {
      "description": "Unique ID of the principal", 
      "maxLength": 255, 
      "pattern": "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$", 
      "readonly": false, 
      "required": true, 
      "title": "Principal Identity ID", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Request to update the certificate of a principal identity", 
  "type": "object"
}

UpgradeBundle (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeBundle", 
  "module_id": "Upgrade", 
  "properties": {
    "file": {
      "readonly": false, 
      "required": true, 
      "title": "Upgrade bundle file", 
      "type": "multipart_file"
    }
  }, 
  "type": "object"
}

UpgradeBundleFetchRequest (type) 

{
  "additionalProperties": false, 
  "description": "URL and other fetch requests of upgrade bundle", 
  "id": "UpgradeBundleFetchRequest", 
  "module_id": "Upgrade", 
  "properties": {
    "url": {
      "description": "URL for uploading upgrade bundle", 
      "readonly": false, 
      "required": true, 
      "title": "URL of upgrade bundle", 
      "type": "string"
    }
  }, 
  "title": "Fetch request for fetching upgrade bundle", 
  "type": "object"
}

UpgradeBundleId (type) 

{
  "additionalProperties": false, 
  "description": "Identifier of the upgrade bundle", 
  "id": "UpgradeBundleId", 
  "module_id": "Upgrade", 
  "properties": {
    "bundle_id": {
      "description": "Identifier of bundle upload", 
      "readonly": true, 
      "required": false, 
      "title": "Bundle Id of upgrade bundle uploaded", 
      "type": "string"
    }
  }, 
  "title": "Bundle id of upgrade bundle", 
  "type": "object"
}

UpgradeBundleInfo (type) 

{
  "additionalProperties": false, 
  "description": "Information about the upgrade bundle", 
  "id": "UpgradeBundleInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "bundle_size": {
      "readonly": true, 
      "required": false, 
      "title": "size of upgrade bundle", 
      "type": "string"
    }, 
    "url": {
      "description": "URL for uploading upgrade bundle", 
      "readonly": true, 
      "required": false, 
      "title": "URL of the upgrade bundle", 
      "type": "string"
    }
  }, 
  "title": "Information about upgrade bundle", 
  "type": "object"
}

UpgradeBundleUploadStatus (type) 

{
  "additionalProperties": false, 
  "description": "Upload status of upgrade bundle uploaded from url", 
  "id": "UpgradeBundleUploadStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "detailed_status": {
      "description": "Detailed status of upgrade bundle upload", 
      "readonly": true, 
      "required": false, 
      "title": "Detailed status of bundle upload", 
      "type": "string"
    }, 
    "percent": {
      "description": "Percent of bundle uploaded from URL", 
      "readonly": true, 
      "required": false, 
      "title": "Percent of upload completed", 
      "type": "number"
    }, 
    "status": {
      "description": "Current status of upgrade bundle upload", 
      "enum": [
        "UPLOADING", 
        "VERIFYING", 
        "SUCCESS", 
        "FAILED"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Status of upgrade bundle upload", 
      "type": "string"
    }, 
    "url": {
      "description": "URL for uploading upgrade bundle", 
      "readonly": true, 
      "required": false, 
      "title": "URL from which the bundle was uploaded", 
      "type": "string"
    }
  }, 
  "title": "Upload status of upgrade bundle", 
  "type": "object"
}

UpgradeHistory (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeHistory", 
  "module_id": "UpgradeTypes", 
  "properties": {
    "initial_version": {
      "description": "Version before the upgrade started", 
      "required": true, 
      "title": "Initial Version", 
      "type": "string"
    }, 
    "target_version": {
      "description": "Version being upgraded to", 
      "required": true, 
      "title": "Target Version", 
      "type": "string"
    }, 
    "timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "required": true, 
      "title": "Timestamp (in milliseconds since epoch) when the upgrade was performed"
    }, 
    "upgrade_status": {
      "enum": [
        "STARTED", 
        "SUCCESS", 
        "FAILED"
      ], 
      "required": true, 
      "title": "Status of the upgrade", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeHistoryList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UpgradeHistoryList", 
  "module_id": "UpgradeTypes", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeHistory"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Upgrade history list", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradePlanResetRequest (type) 

{
  "additionalProperties": false, 
  "id": "UpgradePlanResetRequest", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradePlanSettings (type) 

{
  "additionalProperties": false, 
  "id": "UpgradePlanSettings", 
  "module_id": "Upgrade", 
  "properties": {
    "parallel": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Upgrade Method to specify whether the upgrade is to be performed serially or in parallel", 
      "type": "boolean"
    }, 
    "pause_after_each_group": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to pause the upgrade after upgrade of each group is completed", 
      "type": "boolean"
    }, 
    "pause_on_error": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to pause the upgrade plan execution when an error occurs", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

UpgradeStatus (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "ccp_status": {
      "$ref": "CCPUpgradeStatus"+, 
      "readonly": true, 
      "required": true, 
      "title": "CCP upgrade status"
    }, 
    "component_status": {
      "items": {
        "$ref": "ComponentUpgradeStatus"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "List of component statuses", 
      "type": "array"
    }, 
    "edge_status": {
      "$ref": "EdgeUpgradeStatus"+, 
      "readonly": true, 
      "required": true, 
      "title": "Edge upgrade status"
    }, 
    "host_status": {
      "$ref": "HostUpgradeStatus"+, 
      "readonly": true, 
      "required": true, 
      "title": "Host upgrade status"
    }, 
    "overall_upgrade_status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeSummary (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeSummary", 
  "module_id": "Upgrade", 
  "properties": {
    "component_target_versions": {
      "items": {
        "$ref": "ComponentTargetVersion"+
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "system_version": {
      "readonly": true, 
      "required": true, 
      "title": "Current system version", 
      "type": "string"
    }, 
    "target_version": {
      "readonly": true, 
      "required": true, 
      "title": "Target system version", 
      "type": "string"
    }, 
    "upgrade_bundle_file_name": {
      "readonly": true, 
      "required": false, 
      "title": "Name of the last successfully uploaded upgrade bundle file", 
      "type": "string"
    }, 
    "upgrade_coordinator_updated": {
      "readonly": true, 
      "required": false, 
      "title": "Has upgrade coordinator been updated after upload of upgrade bundle file", 
      "type": "boolean"
    }, 
    "upgrade_coordinator_version": {
      "readonly": true, 
      "required": true, 
      "title": "Current version of upgrade coordinator", 
      "type": "string"
    }, 
    "upgrade_status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnit (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "UpgradeUnit", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "current_version": {
      "description": "This is component version e.g. if upgrade unit is of type edge, then this is edge version.", 
      "readonly": true, 
      "required": false, 
      "title": "Current version of upgrade unit", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": false, 
      "required": false, 
      "title": "Name of the upgrade unit", 
      "type": "string"
    }, 
    "group": {
      "$ref": "UpgradeUnitGroupInfo"+, 
      "readonly": true, 
      "required": false, 
      "title": "Info of the group to which this upgrade unit belongs"
    }, 
    "id": {
      "description": "Identifier of the upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of the upgrade unit", 
      "type": "string"
    }, 
    "metadata": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Metadata about upgrade unit", 
      "type": "array"
    }, 
    "type": {
      "readonly": false, 
      "required": false, 
      "title": "Upgrade unit type", 
      "type": "string"
    }, 
    "warnings": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of warnings indicating issues with the upgrade unit that may result in upgrade failure", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitAggregateInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "UpgradeUnitAggregateInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "current_version": {
      "description": "This is component version e.g. if upgrade unit is of type edge, then this is edge version.", 
      "readonly": true, 
      "required": false, 
      "title": "Current version of upgrade unit", 
      "type": "string"
    }, 
    "display_name": {
      "readonly": false, 
      "required": false, 
      "title": "Name of the upgrade unit", 
      "type": "string"
    }, 
    "errors": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of errors occurred during upgrade of this upgrade unit", 
      "type": "array"
    }, 
    "group": {
      "$ref": "UpgradeUnitGroupInfo"+, 
      "readonly": true, 
      "required": false, 
      "title": "Info of the group to which this upgrade unit belongs"
    }, 
    "id": {
      "description": "Identifier of the upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "Identifier of the upgrade unit", 
      "type": "string"
    }, 
    "metadata": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Metadata about upgrade unit", 
      "type": "array"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade unit", 
      "type": "string"
    }, 
    "type": {
      "readonly": false, 
      "required": false, 
      "title": "Upgrade unit type", 
      "type": "string"
    }, 
    "warnings": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of warnings indicating issues with the upgrade unit that may result in upgrade failure", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitAggregateInfoListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "UpgradeUnitAggregateInfoListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "group_id": {
      "readonly": false, 
      "required": false, 
      "title": "Identifier of group based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "has_errors": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to return only upgrade units with errors", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "metadata": {
      "readonly": false, 
      "required": false, 
      "title": "Metadata about upgrade unit to filter on", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "selection_status": {
      "default": "ALL", 
      "enum": [
        "SELECTED", 
        "DESELECTED", 
        "ALL"
      ], 
      "required": false, 
      "title": "Flag to indicate whether to return only selected, only deselected or both type of upgrade units", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitAggregateInfoListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UpgradeUnitAggregateInfoListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitAggregateInfo"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Paged collection of UpgradeUnit AggregateInfo", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroup (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "UpgradeUnitGroup", 
  "module_id": "Upgrade", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether upgrade of this group is enabled or not", 
      "type": "boolean"
    }, 
    "extended_configuration": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "Extended configuration for the group", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "parallel": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Upgrade method to specify whether the upgrade is to be performed in parallel or serially", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "upgrade_unit_count": {
      "description": "Number of upgrade units in the group", 
      "readonly": true, 
      "required": false, 
      "title": "Count of upgrade units in the group", 
      "type": "int"
    }, 
    "upgrade_units": {
      "items": {
        "$ref": "UpgradeUnit"+
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "List of upgrade units in the group", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupAggregateInfo (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "UpgradeUnitGroupAggregateInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether upgrade of this group is enabled or not", 
      "type": "boolean"
    }, 
    "extended_configuration": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "Extended configuration for the group", 
      "type": "array"
    }, 
    "failed_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes in the upgrade unit group that failed upgrade", 
      "type": "int"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "parallel": {
      "default": true, 
      "readonly": false, 
      "required": false, 
      "title": "Upgrade method to specify whether the upgrade is to be performed in parallel or serially", 
      "type": "boolean"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of upgrade unit group", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }, 
    "upgrade_unit_count": {
      "description": "Number of upgrade units in the group", 
      "readonly": true, 
      "required": false, 
      "title": "Count of upgrade units in the group", 
      "type": "int"
    }, 
    "upgrade_units": {
      "items": {
        "$ref": "UpgradeUnit"+
      }, 
      "maxItems": 100, 
      "readonly": false, 
      "required": false, 
      "title": "List of upgrade units in the group", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupAggregateInfoListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UpgradeUnitGroupAggregateInfoListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitGroupAggregateInfo"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Paged collection of upgrade status for upgrade unit groups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupInfo (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeUnitGroupInfo", 
  "module_id": "Upgrade", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of the group", 
      "type": "string"
    }, 
    "id": {
      "description": "Identifier of group", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of group", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "UpgradeUnitGroupListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade unit groups to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "summary": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag indicating whether to return summary", 
      "type": "boolean"
    }, 
    "sync": {
      "default": false, 
      "description": "If true, synchronize with the management plane before returning upgrade unit groups", 
      "required": false, 
      "title": "Synchronize before returning upgrade unit groups", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UpgradeUnitGroupListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitGroup"+
      }, 
      "required": true, 
      "title": "Paged Collection of Upgrade unit groups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupStatus (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeUnitGroupStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "failed_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes in the upgrade unit group that failed upgrade", 
      "type": "int"
    }, 
    "group_id": {
      "description": "Identifier for upgrade unit group", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of upgrade unit group", 
      "type": "string"
    }, 
    "group_name": {
      "description": "Name of the upgrade unit group", 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade unit group Name", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Upgrade status of upgrade unit group", 
      "type": "string"
    }, 
    "upgrade_unit_count": {
      "readonly": true, 
      "required": true, 
      "title": "Number of upgrade units in the group", 
      "type": "int"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupStatusListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UpgradeUnitGroupStatusListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitGroupStatus"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Paged collection of upgrade status for upgrade unit groups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitList (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeUnitList", 
  "module_id": "Upgrade", 
  "properties": {
    "list": {
      "items": {
        "$ref": "UpgradeUnit"+
      }, 
      "required": true, 
      "title": "Collection of Upgrade units", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "UpgradeUnitListRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": false, 
      "title": "Component type based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "current_version": {
      "readonly": false, 
      "required": false, 
      "title": "Current version of upgrade unit based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "group_id": {
      "readonly": false, 
      "required": false, 
      "title": "UUID of group based on which upgrade units to be filtered", 
      "type": "string"
    }, 
    "has_warnings": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Flag to indicate whether to return only upgrade units with warnings", 
      "type": "boolean"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "metadata": {
      "readonly": false, 
      "required": false, 
      "title": "Metadata about upgrade unit to filter on", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "upgrade_unit_type": {
      "readonly": false, 
      "required": false, 
      "title": "Upgrade unit type based on which upgrade units to be filtered", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UpgradeUnitListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnit"+
      }, 
      "required": true, 
      "title": "Paged Collection of Upgrade units", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitStatus (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeUnitStatus", 
  "module_id": "Upgrade", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "Name of upgrade unit", 
      "type": "string"
    }, 
    "errors": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of errors occurred during upgrade of this upgrade unit", 
      "type": "array"
    }, 
    "id": {
      "description": "Identifier of upgrade unit", 
      "readonly": true, 
      "required": true, 
      "title": "UUID of upgrade unit", 
      "type": "string"
    }, 
    "percent_complete": {
      "readonly": true, 
      "required": true, 
      "title": "Indicator of upgrade progress in percentage", 
      "type": "number"
    }, 
    "status": {
      "enum": [
        "SUCCESS", 
        "FAILED", 
        "IN_PROGRESS", 
        "NOT_STARTED", 
        "PAUSED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Status of upgrade unit", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitStatusListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "UpgradeUnitStatusListResult", 
  "module_id": "Upgrade", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "UpgradeUnitStatus"+
      }, 
      "required": true, 
      "title": "Paged Collection of upgrade units status", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitTypeStats (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeUnitTypeStats", 
  "module_id": "Upgrade", 
  "properties": {
    "node_count": {
      "readonly": true, 
      "required": true, 
      "title": "Number of nodes", 
      "type": "int"
    }, 
    "node_with_issues_count": {
      "readonly": true, 
      "required": false, 
      "title": "Number of nodes with issues that may cause upgrade failure", 
      "type": "int"
    }, 
    "type": {
      "readonly": true, 
      "required": true, 
      "title": "Type of upgrade unit", 
      "type": "string"
    }, 
    "version": {
      "readonly": true, 
      "required": true, 
      "title": "Version of the upgrade unit", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitTypeStatsList (type) 

{
  "additionalProperties": false, 
  "id": "UpgradeUnitTypeStatsList", 
  "module_id": "Upgrade", 
  "properties": {
    "results": {
      "items": {
        "$ref": "UpgradeUnitTypeStats"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of upgrade unit type stats", 
      "type": "array"
    }
  }, 
  "type": "object"
}

UpgradeUnitsStatsRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "UpgradeUnitsStatsRequestParameters", 
  "module_id": "Upgrade", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "sync": {
      "default": false, 
      "description": "If true, synchronize with the management plane before returning upgrade unit stats", 
      "required": false, 
      "title": "Synchronize before returning upgrade unit stats", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

Uplink (type) 

{
  "id": "Uplink", 
  "module_id": "UplinkHostSwitchProfile", 
  "properties": {
    "uplink_name": {
      "help_summary": "the max length of the name is 47-byte in UTF-8 encoding", 
      "required": true, 
      "title": "Name of this uplink", 
      "type": "string"
    }, 
    "uplink_type": {
      "enum": [
        "PNIC", 
        "LAG"
      ], 
      "required": true, 
      "title": "Type of the uplink", 
      "type": "string"
    }
  }, 
  "title": "Object to identify an uplink based on its type and name", 
  "type": "object"
}

UplinkHostSwitchProfile (type) 

{
  "extends": {
    "$ref": "BaseHostSwitchProfile"+
  }, 
  "id": "UplinkHostSwitchProfile", 
  "module_id": "UplinkHostSwitchProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "UplinkHostSwitchProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lags": {
      "items": {
        "$ref": "Lag"+
      }, 
      "maxItems": 64, 
      "required": false, 
      "title": "list of LACP group", 
      "type": "array"
    }, 
    "mtu": {
      "default": 1600, 
      "maximum": 9000, 
      "minimum": 1280, 
      "required": false, 
      "title": "Maximum Transmission Unit used for uplinks", 
      "type": "int"
    }, 
    "named_teamings": {
      "help_summary": "If this field is not provided, logical switches will not have specific teaming policies applied to them; the default teaming policy will be used. For Non-ESX transport nodes that do not support specific uplink teaming policies on logical switches, their UplinkHostSwitchProfiles must NOT set this property; the default TeamingPolicy will always be used.", 
      "items": {
        "$ref": "NamedTeamingPolicy"+
      }, 
      "maxItems": 32, 
      "required": false, 
      "title": "List of named uplink teaming policies that can be used by logical switches", 
      "type": "array"
    }, 
    "overlay_encap": {
      "default": "GENEVE", 
      "enum": [
        "VXLAN", 
        "GENEVE"
      ], 
      "required": false, 
      "title": "The protocol used to encapsulate overlay traffic", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "HostSwitchProfileType"+, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "teaming": {
      "$ref": "TeamingPolicy"+, 
      "help_summary": "This is the default TeamingPolicy used on TransportNodes that use this UplinkHostSwitchProfile for the logical switches that do not have any NamedTeamingPolicy assigned.", 
      "required": true, 
      "title": "Default TeamingPolicy associated with this UplinkProfile"
    }, 
    "transport_vlan": {
      "$ref": "VlanID"+, 
      "default": 0, 
      "required": false, 
      "title": "VLAN used for tagging Overlay traffic of associated HostSwitch"
    }
  }, 
  "title": "Profile for uplink policies", 
  "type": "object"
}

UpmEntityType (type) 

{
  "description": "All entity types supported.", 
  "enum": [
    "LogicalPort", 
    "LogicalSwitch", 
    "NSGroup"
  ], 
  "id": "UpmEntityType", 
  "module_id": "UpmCommon", 
  "title": "Supported Entity Types", 
  "type": "string"
}

UrlAlias (type) 

{
  "additionalProperties": false, 
  "description": "Short name or alias of a url. It is used to represent the url.", 
  "id": "UrlAlias", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "alias": {
      "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 $<index> (for example, $0).", 
      "maxLength": 255, 
      "title": "Url Alias Name", 
      "type": "string"
    }, 
    "query": {
      "description": "Search query to be applied, if any. If query string is not provided, it will be ignored.", 
      "maxLength": 1024, 
      "title": "Search query of the search api, if any", 
      "type": "string"
    }, 
    "url": {
      "description": "Url to fetch data from.", 
      "maxLength": 1024, 
      "required": true, 
      "title": "Url", 
      "type": "string"
    }
  }, 
  "title": "Url Alias", 
  "type": "object"
}

UrpfMode (type) 

{
  "enum": [
    "NONE", 
    "STRICT"
  ], 
  "id": "UrpfMode", 
  "module_id": "LogicalRouterPorts", 
  "title": "Unicast Reverse Path Forwarding mode", 
  "type": "string"
}

UserGroupType (type) 

{
  "enum": [
    "read_only_api_users", 
    "read_write_api_users", 
    "superusers", 
    "undefined"
  ], 
  "id": "UserGroupType", 
  "module_id": "CertificateManager", 
  "title": "Supported groups a principal identity can belong to.", 
  "type": "string"
}

UserInfo (type) 

{
  "id": "UserInfo", 
  "module_id": "AAA", 
  "properties": {
    "roles": {
      "items": {
        "$ref": "NsxRole"+
      }, 
      "readonly": true, 
      "required": true, 
      "title": "Permissions", 
      "type": "array"
    }, 
    "user_name": {
      "readonly": true, 
      "required": true, 
      "title": "User Name", 
      "type": "string"
    }
  }, 
  "title": "Authenticated User Info", 
  "type": "object"
}

UsernamePasswordLoginCredential (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LoginCredential"+
  }, 
  "id": "UsernamePasswordLoginCredential", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "UsernamePasswordLoginCredential"
  }, 
  "properties": {
    "credential_type": {
      "description": "Possible values are 'UsernamePasswordLoginCredential', 'VerifiableAsymmetricLoginCredential'.", 
      "required": true, 
      "title": "Login credential, for example username-password-thumbprint or certificate based, etc", 
      "type": "string"
    }, 
    "password": {
      "required": false, 
      "sensitive": true, 
      "title": "The authentication password for login", 
      "type": "string"
    }, 
    "thumbprint": {
      "pattern": "^(([0-9A-Fa-f]{2}[:])+([0-9A-Fa-f]{2}))?$", 
      "required": false, 
      "title": "Thumbprint of the login server", 
      "type": "string"
    }, 
    "username": {
      "required": false, 
      "title": "The username for login", 
      "type": "string"
    }
  }, 
  "title": "A login credential specifying a username and password", 
  "type": "object"
}

VIPSubnet (type) 

{
  "additionalProperties": false, 
  "id": "VIPSubnet", 
  "module_id": "LogicalRouter", 
  "properties": {
    "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.", 
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": true, 
      "title": "IPv4 Addresses which will be owned by uplink on active node.", 
      "type": "array"
    }, 
    "prefix_length": {
      "maximum": 31, 
      "minimum": 1, 
      "required": true, 
      "title": "Subnet Prefix Length", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

VerifiableAsymmetricLoginCredential (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LoginCredential"+
  }, 
  "id": "VerifiableAsymmetricLoginCredential", 
  "module_id": "Types", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VerifiableAsymmetricLoginCredential"
  }, 
  "properties": {
    "asymmetric_credential": {
      "required": false, 
      "sensitive": true, 
      "title": "Asymmetric login credential", 
      "type": "string"
    }, 
    "credential_key": {
      "required": false, 
      "sensitive": true, 
      "title": "Credential key", 
      "type": "string"
    }, 
    "credential_type": {
      "description": "Possible values are 'UsernamePasswordLoginCredential', 'VerifiableAsymmetricLoginCredential'.", 
      "required": true, 
      "title": "Login credential, for example username-password-thumbprint or certificate based, etc", 
      "type": "string"
    }, 
    "credential_verifier": {
      "required": false, 
      "sensitive": true, 
      "title": "Credential verifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VersionList (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "VersionList", 
  "module_id": "VersionWhitelist", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "acceptable_versions": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "List of component versions", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

VersionedDeploymentSpec (type) 

{
  "additionalProperties": false, 
  "id": "VersionedDeploymentSpec", 
  "module_id": "HostPrepServiceFabric", 
  "properties": {
    "host_type": {
      "enum": [
        "ESXI", 
        "RHELKVM", 
        "UBUNTUKVM", 
        "RHELCONTAINER", 
        "RHELSERVER", 
        "UBUNTUSERVER", 
        "CENTOSSERVER", 
        "CENTOSKVM"
      ], 
      "required": true, 
      "title": "type of host", 
      "type": "string"
    }, 
    "host_version": {
      "required": true, 
      "title": "version of the host", 
      "type": "string"
    }, 
    "package_stores": {
      "items": {
        "$ref": "PackageStore"+
      }, 
      "required": true, 
      "title": "Package store contains package url and bulletin_ids", 
      "type": "array"
    }, 
    "service_vm_ovf_url": {
      "items": {
        "type": "string"
      }, 
      "title": "list of service vm ovf urls", 
      "type": "array"
    }
  }, 
  "title": "Versioned DeploymentSpec contains vibs and ofv urls for specific version of fabric module and host type and host version.", 
  "type": "object"
}

VidmInfo (type) 

{
  "id": "VidmInfo", 
  "module_id": "AAA", 
  "properties": {
    "display_name": {
      "readonly": true, 
      "required": true, 
      "title": "User's Full Name Or User Group's Display Name", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "Username Or Groupname", 
      "type": "string"
    }, 
    "type": {
      "enum": [
        "remote_user", 
        "remote_group"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Type", 
      "type": "string"
    }
  }, 
  "title": "Vidm Info", 
  "type": "object"
}

VidmInfoListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "VidmInfoListResult", 
  "module_id": "AAA", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VidmInfo"+
      }, 
      "required": true, 
      "title": "List results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VidmInfoSearchRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "VidmInfoSearchRequestParameters", 
  "module_id": "AAA", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "search_string": {
      "description": "This is a substring search that is case insensitive.\n", 
      "required": true, 
      "title": "Search string to search for.\n", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Vidm information search request parameters", 
  "type": "object"
}

View (type) 

{
  "additionalProperties": false, 
  "description": "Describes the configuration of a view to be displayed on the dashboard.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "View", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "exclude_roles": {
      "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.", 
      "maxLength": 1024, 
      "title": "Roles to which the shared view is not visible", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "include_roles": {
      "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.", 
      "maxLength": 1024, 
      "title": "Roles to which the shared view is visible", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "shared": {
      "default": false, 
      "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", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "default": 10000, 
      "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", 
      "type": "int"
    }, 
    "widgets": {
      "description": "Array of widgets that are part of the view.", 
      "items": {
        "$ref": "WidgetItem"+
      }, 
      "minItems": 0, 
      "required": true, 
      "title": "Widgets", 
      "type": "array"
    }
  }, 
  "title": "Dashboard View", 
  "type": "object"
}

VifAttachmentContext (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "AttachmentContext"+
  }, 
  "id": "VifAttachmentContext", 
  "module_id": "LogicalPort", 
  "nsx_feature": "Container", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VifAttachmentContext"
  }, 
  "properties": {
    "allocate_addresses": {
      "enum": [
        "IpPool", 
        "MacPool", 
        "Both", 
        "None"
      ], 
      "required": false, 
      "title": "A flag to indicate whether to allocate addresses from allocation\n    pools bound to the parent logical switch.\n", 
      "type": "string"
    }, 
    "app_id": {
      "description": "An application ID used to identify / look up a child VIF\nbehind a parent VIF. Only effective when vif_type is CHILD.\n", 
      "required": false, 
      "title": "ID used to identify/look up a child VIF behind a parent VIF", 
      "type": "string"
    }, 
    "parent_vif_id": {
      "required": false, 
      "title": "VIF ID of the parent VIF if vif_type is CHILD", 
      "type": "string"
    }, 
    "resource_type": {
      "help_summary": "Possible values are 'VifAttachmentContext' or 'L2VpnAttachmentContext'\n", 
      "required": true, 
      "title": "Used to identify which concrete class it is", 
      "type": "string"
    }, 
    "traffic_tag": {
      "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", 
      "required": false, 
      "title": "Tag used for the traffic between this VIF and parent VIF", 
      "type": "int"
    }, 
    "transport_node_uuid": {
      "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", 
      "required": false, 
      "title": "The UUID of the transport node", 
      "type": "string"
    }, 
    "vif_type": {
      "enum": [
        "PARENT", 
        "CHILD", 
        "INDEPENDENT"
      ], 
      "required": true, 
      "title": "Type of the VIF attached to logical port", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VifListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "VifListRequestParameters", 
  "module_id": "Inventory", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "host_id": {
      "required": false, 
      "title": "Id of the host where this vif is located.", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "lport_attachment_id": {
      "required": false, 
      "title": "LPort Attachment Id of the virtual network interface.", 
      "type": "string"
    }, 
    "owner_vm_id": {
      "required": false, 
      "title": "External id of the virtual machine.", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vm_id": {
      "required": false, 
      "title": "External id of the virtual machine.", 
      "type": "string"
    }
  }, 
  "title": "VirtualNetworkInterface list request parameters.", 
  "type": "object"
}

VirtualMachine (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource"+
  }, 
  "id": "VirtualMachine", 
  "module_id": "Inventory", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "compute_ids": {
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "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']", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": true, 
      "title": "Current external id of this virtual machine in the system.", 
      "type": "string"
    }, 
    "host_id": {
      "required": false, 
      "title": "Id of the host in which this virtual machine exists.", 
      "type": "string"
    }, 
    "local_id_on_host": {
      "required": true, 
      "title": "Id of the vm unique within the host.", 
      "type": "string"
    }, 
    "power_state": {
      "enum": [
        "VM_RUNNING", 
        "VM_STOPPED", 
        "VM_SUSPENDED", 
        "UNKNOWN"
      ], 
      "required": true, 
      "title": "Current power state of this virtual machine in the system.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "source": {
      "$ref": "ResourceReference"+, 
      "required": false, 
      "title": "Reference of the Host or Public Cloud Gateway that reported the VM"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "enum": [
        "EDGE", 
        "SERVICE", 
        "REGULAR"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Virtual Machine type; Edge, Service VM or other.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VirtualMachineListRequestParameters (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "VirtualMachineListRequestParameters", 
  "module_id": "Inventory", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "display_name": {
      "required": false, 
      "title": "Display Name of the virtual machine", 
      "type": "string"
    }, 
    "external_id": {
      "required": false, 
      "title": "External id of the virtual machine", 
      "type": "string"
    }, 
    "host_id": {
      "required": false, 
      "title": "Id of the host where this vif is located", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "VirtualMachine list request parameters.", 
  "type": "object"
}

VirtualMachineListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "VirtualMachineListResult", 
  "module_id": "Inventory", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VirtualMachine"+
      }, 
      "required": true, 
      "title": "VirtualMachine list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VirtualNetworkInterface (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "DiscoveredResource"+
  }, 
  "id": "VirtualNetworkInterface", 
  "module_id": "Inventory", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "device_key": {
      "required": true, 
      "title": "Device key of the virtual network interface.", 
      "type": "string"
    }, 
    "device_name": {
      "required": false, 
      "title": "Device name of the virtual network interface.", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "required": true, 
      "title": "External Id of the virtual network inferface.", 
      "type": "string"
    }, 
    "host_id": {
      "required": true, 
      "title": "Id of the host on which the vm exists.", 
      "type": "string"
    }, 
    "ip_address_info": {
      "items": {
        "$ref": "IpAddressInfo"+
      }, 
      "required": false, 
      "title": "IP Addresses of the the virtual network interface, from various sources.", 
      "type": "array"
    }, 
    "lport_attachment_id": {
      "required": false, 
      "title": "LPort Attachment Id of the virtual network interface.", 
      "type": "string"
    }, 
    "mac_address": {
      "required": true, 
      "title": "MAC address of the virtual network interface.", 
      "type": "string"
    }, 
    "owner_vm_id": {
      "required": true, 
      "title": "Id of the vm to which this virtual network interface belongs.", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "vm_local_id_on_host": {
      "required": true, 
      "title": "Id of the vm unique within the host.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VirtualNetworkInterfaceListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "VirtualNetworkInterfaceListResult", 
  "module_id": "Inventory", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VirtualNetworkInterface"+
      }, 
      "required": true, 
      "title": "VirtualNetworkInterface list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VirtualServerIpProtocol (type) 

{
  "additionalProperties": false, 
  "description": "Assigned Internet protocol in IP header, TCP and UDP are supported.\n", 
  "enum": [
    "TCP", 
    "UDP"
  ], 
  "id": "VirtualServerIpProtocol", 
  "module_id": "LoadBalancer", 
  "title": "IP protocol of virtual server", 
  "type": "string"
}

VirtualServiceInstance (type) 

{
  "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).", 
  "extends": {
    "$ref": "BaseServiceInstance"+
  }, 
  "id": "VirtualServiceInstance", 
  "module_id": "ServiceInsertionCommonTypes", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VirtualServiceInstance"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "on_failure_policy": {
      "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.", 
      "enum": [
        "ALLOW", 
        "BLOCK"
      ], 
      "required": false, 
      "title": "On Failure Policy", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "ServiceInstanceResourceType"+, 
      "required": true
    }, 
    "service_id": {
      "description": "The Service to which the service instance is associated.", 
      "readonly": true, 
      "required": false, 
      "title": "Service Id", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_type": {
      "description": "Transport to be used by this service instance for deploying the Service-VM.", 
      "enum": [
        "L2_BRIDGE", 
        "L3_ROUTED"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Transport Type", 
      "type": "string"
    }
  }, 
  "title": "Custom Instance of a service", 
  "type": "object"
}

VlanID (type) 

{
  "id": "VlanID", 
  "maximum": 4094, 
  "minimum": 0, 
  "module_id": "Types", 
  "title": "Virtual Local Area Network Identifier", 
  "type": "integer"
}

VlanMirrorSource (type) 

{
  "extends": {
    "$ref": "MirrorSource"+
  }, 
  "id": "VlanMirrorSource", 
  "module_id": "PortMirroring", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VlanMirrorSource"
  }, 
  "properties": {
    "resource_type": {
      "$ref": "MirrorSourceResourceType"+, 
      "help_summary": "Possible values are 'LogicalPortMirrorSource', 'PnicMirrorSource'", 
      "required": true
    }, 
    "vlan_ids": {
      "items": {
        "$ref": "VlanID"+
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Source VLAN ID list", 
      "type": "array"
    }
  }, 
  "type": "object"
}

VlanTrunkSpec (type) 

{
  "description": "VlanTrunkspec is used for specifying trunk VLAN id ranges.", 
  "id": "VlanTrunkSpec", 
  "module_id": "LogicalSwitch", 
  "properties": {
    "vlan_ranges": {
      "items": {
        "$ref": "TrunkVlanRange"+
      }, 
      "required": true, 
      "title": "Trunk VLAN id ranges", 
      "type": "array"
    }
  }, 
  "title": "VLAN trunk range specification", 
  "type": "object"
}

VmNicInfo (type) 

{
  "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.", 
  "id": "VmNicInfo", 
  "module_id": "ServiceInsertionCommonTypes", 
  "properties": {
    "nic_infos": {
      "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.", 
      "items": {
        "$ref": "NicInfo"+
      }, 
      "readonly": false, 
      "required": true, 
      "title": "Set of NIC information of a VM", 
      "type": "array"
    }
  }, 
  "title": "Set of NIC information of a VM", 
  "type": "object"
}

VmkToLogicalSwitchMapping (type) 

{
  "additionalProperties": false, 
  "id": "VmkToLogicalSwitchMapping", 
  "module_id": "TransportNode", 
  "nsx_feature": "HostProfileSupport", 
  "properties": {
    "dest_network_id": {
      "description": "Only VLAN type of logical switch can be specified here, as migration operation is only supported for these types.", 
      "required": true, 
      "title": "The ID of the NSX logical switch to which source vmkernal interface needs to be migrated to.", 
      "type": "string"
    }, 
    "src_interface_id": {
      "required": true, 
      "title": "The ID (for example, vmk0) of the vmkernal interface on ESX to migrate.", 
      "type": "string"
    }
  }, 
  "title": "Holds VMkernal to logical switch mapping. This will be used for network migration.", 
  "type": "object"
}

VnetStats (type) 

{
  "additionalProperties": false, 
  "description": "Stores statistics of the number of MANAGED and UNMANAGED virtual networks.\n", 
  "id": "VnetStats", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "managed": {
      "description": "The number of virtual networks with status MANAGED.", 
      "readonly": true, 
      "required": false, 
      "title": "Managed virtual networks", 
      "type": "integer"
    }, 
    "unmanaged": {
      "description": "The number of vitual networks with status UNMANAGED.", 
      "readonly": true, 
      "required": false, 
      "title": "Unmanaged virtual networks", 
      "type": "integer"
    }
  }, 
  "title": "Virtual Network statistics", 
  "type": "object"
}

VniPool (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "VniPool", 
  "module_id": "Vnim", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ranges": {
      "items": {
        "$ref": "VniRange"+
      }, 
      "required": true, 
      "title": "VNI range list results", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

VniPoolListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "VniPoolListResult", 
  "module_id": "Vnim", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VniPool"+
      }, 
      "required": true, 
      "title": "VNI pool list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VniRange (type) 

{
  "additionalProperties": false, 
  "description": "A range of virtual network identifiers (VNIs)", 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "VniRange", 
  "module_id": "Vnim", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "end": {
      "description": "End value for vni range to be used for virtual networks", 
      "maximum": 16777215, 
      "minimum": 5000, 
      "readonly": false, 
      "required": true, 
      "title": "End value of vni range", 
      "type": "integer"
    }, 
    "start": {
      "description": "Start value for vni range to be used for virtual networks", 
      "maximum": 16777215, 
      "minimum": 5000, 
      "readonly": false, 
      "required": true, 
      "title": "Start value of vni range", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

VpcStats (type) 

{
  "additionalProperties": false, 
  "description": "Stores statistics of the number of MANAGED and UNMANAGED VPCs.\n", 
  "id": "VpcStats", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "managed": {
      "description": "The number of VPCs with status MANAGED.", 
      "readonly": true, 
      "required": false, 
      "title": "Managed VPCs", 
      "type": "integer"
    }, 
    "unmanaged": {
      "description": "The number of VPCs with status UNMANAGED.", 
      "readonly": true, 
      "required": false, 
      "title": "Unmanaged VPCs", 
      "type": "integer"
    }
  }, 
  "title": "VPC statistics", 
  "type": "object"
}

VpnRoutingTableState (type) 

{
  "description": "State of a public cloud routing table from VPN point of view", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "VpnRoutingTableState", 
  "module_id": "VpnCloudRoutingTables", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "account_id": {
      "required": true, 
      "title": "Identifier for account based on which routing tables are to be filtered", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "description": "The identifier of the public cloud routing table\n", 
      "required": true, 
      "title": "Public Cloud Routing Table Identifier", 
      "type": "string"
    }, 
    "managed_for_vpn": {
      "description": "Flag to identify whether the routing table is actually managed by NSX for VPN", 
      "required": true, 
      "title": "NSX Managed Routing Table", 
      "type": "boolean"
    }, 
    "network_id": {
      "required": true, 
      "title": "Identifier for a network based on which the list are to be filtered\n", 
      "type": "string"
    }, 
    "reason_for_not_managed": {
      "description": "Reason why a routing table is not being managed for VPN", 
      "enum": [
        "RT_CONTAINS_MGMT_SUBNET", 
        "RT_CONTAINS_UPLINK_SUBNET", 
        "RT_CONTAINS_MGMT_UPLINK_SUBNET", 
        "NONSELECTED"
      ], 
      "required": false, 
      "title": "Unmanaged Table Reason", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Public Cloud Routing Table State", 
  "type": "object"
}

VpnRoutingTableStateListResult (type) 

{
  "description": "List of public cloud routing tables and their state. It contains the state information relevant for VPN.", 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "VpnRoutingTableStateListResult", 
  "module_id": "VpnCloudRoutingTables", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "description": "Set of public cloud routing tables and their state", 
      "items": {
        "$ref": "VpnRoutingTableState"+
      }, 
      "required": true, 
      "title": "Public Cloud Routing State Tables", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "List of Public Cloud Routing State", 
  "type": "object"
}

VpnRoutingTablesStateListRequestParameters (type) 

{
  "additionalProperties": false, 
  "description": "These parameters can be used to filter the list of routing table states.\nMultiple parameters can be given as input. Different parameters are implicitly 'AND'ed.\n", 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "VpnRoutingTablesStateListRequestParameters", 
  "module_id": "VpnCloudRoutingTables", 
  "properties": {
    "account_id": {
      "required": false, 
      "title": "Identifier for account based on which routing tables are to be filtered", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "managed_for_vpn": {
      "required": false, 
      "title": "Flag to identify whether the routing table is actually managed by NSX for VPN", 
      "type": "boolean"
    }, 
    "network_id": {
      "required": false, 
      "title": "Identifier for a network based on which the list is to be filtered\n", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "reason_for_not_managed": {
      "enum": [
        "RT_CONTAINS_MGMT_SUBNET", 
        "RT_CONTAINS_UPLINK_SUBNET", 
        "RT_CONTAINS_MGMT_UPLINK_SUBNET", 
        "NONSELECTED"
      ], 
      "required": false, 
      "title": "Reason why a routing table is not being managed for VPN", 
      "type": "string"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VsphereClusterNodeVMDeploymentConfig (type) 

{
  "description": "Config for deploying a cluster node VM through a Vcenter server\n", 
  "extends": {
    "$ref": "ClusterNodeVMDeploymentConfig"+
  }, 
  "id": "VsphereClusterNodeVMDeploymentConfig", 
  "module_id": "ClusterNodeVMDeployment", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VsphereClusterNodeVMDeploymentConfig"
  }, 
  "properties": {
    "allow_ssh_root_login": {
      "default": false, 
      "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", 
      "required": false, 
      "title": "Allow root SSH logins.", 
      "type": "boolean"
    }, 
    "compute_id": {
      "description": "The cluster node VM will be deployed on the specified cluster or\nresourcepool for specified VC server.\n", 
      "required": true, 
      "title": "Cluster identifier or resourcepool identifier", 
      "type": "string"
    }, 
    "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: Controllers deployed using DHCP are currently not supported,\nso this parameter should be specified for deploying Controllers.\n", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "Default gateway for the VM", 
      "type": "array"
    }, 
    "dns_servers": {
      "description": "List of DNS servers.\nIf DHCP is used, the default DNS servers associated with\nthe DHCP server will be used instead.\n", 
      "items": {
        "$ref": "IPv4Address"+
      }, 
      "required": false, 
      "title": "DNS servers.", 
      "type": "array"
    }, 
    "enable_ssh": {
      "default": false, 
      "description": "If true, the SSH service will automatically be started on the VM.\nEnabling SSH service is not recommended for security reasons.\n", 
      "required": false, 
      "title": "Enable SSH.", 
      "type": "boolean"
    }, 
    "host_id": {
      "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", 
      "required": false, 
      "title": "Host identifier", 
      "type": "string"
    }, 
    "hostname": {
      "description": "Desired host name/FQDN for the VM to be deployed", 
      "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])?)*?$", 
      "required": true, 
      "title": "Host name or FQDN for the VM", 
      "type": "string"
    }, 
    "management_network_id": {
      "description": "Distributed portgroup identifier to which the management vnic of\ncluster node VM will be connected.\n", 
      "required": true, 
      "title": "Portgroup identifier for management network connectivity", 
      "type": "string"
    }, 
    "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: Controllers deployed using DHCP are currently not supported,\nso this parameter should be specified for deploying Controllers.\n", 
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "Port subnets for management port", 
      "type": "array"
    }, 
    "ntp_servers": {
      "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", 
      "items": {
        "$ref": "HostnameOrIPv4Address"+
      }, 
      "required": false, 
      "title": "NTP servers.", 
      "type": "array"
    }, 
    "placement_type": {
      "description": "Specifies the config for the platform through which to deploy the VM\n", 
      "enum": [
        "VsphereClusterNodeVMDeploymentConfig"
      ], 
      "required": true, 
      "title": "Type of deployment", 
      "type": "string"
    }, 
    "storage_id": {
      "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", 
      "required": true, 
      "title": "Storage/datastore identifier", 
      "type": "string"
    }, 
    "vc_id": {
      "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", 
      "required": true, 
      "title": "Vsphere compute identifier for identifying VC server", 
      "type": "string"
    }
  }, 
  "title": "Deployment config on the Vsphere platform", 
  "type": "object"
}

VsphereDeploymentConfig (type) 

{
  "additionalProperties": false, 
  "description": "The Vsphere deployment configuration determines where to deploy the edge\nnode. It contains settings that are applied during install time.\nIf using DHCP, you must leave the following fields unset: search_domains,\nmanagement_port_subnets, dns_servers and default_gateway_addresses.\n", 
  "extends": {
    "$ref": "DeploymentConfig"+
  }, 
  "id": "VsphereDeploymentConfig", 
  "module_id": "FabricNode", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VsphereDeploymentConfig"
  }, 
  "properties": {
    "allow_ssh_root_login": {
      "default": false, 
      "description": "Allowing root SSH logins is not recommended for security reasons.\n", 
      "required": false, 
      "title": "Allow root SSH logins.", 
      "type": "boolean"
    }, 
    "compute_id": {
      "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", 
      "required": true, 
      "title": "Cluster identifier or resourcepool identifier for specified vcenter server.", 
      "type": "string"
    }, 
    "data_network_ids": {
      "description": "List of distributed portgroup or VLAN logical identifiers to which the\ndatapath serving vnics of edge node vm will be connected.\n", 
      "items": {
        "type": "string"
      }, 
      "maxItems": 3, 
      "minItems": 3, 
      "required": true, 
      "title": "Portgroup or logical switch identifiers for datapath connectivity.", 
      "type": "array"
    }, 
    "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", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "Default gateway for the node.", 
      "type": "array"
    }, 
    "dns_servers": {
      "description": "List of DNS servers.\n", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": false, 
      "title": "DNS servers.", 
      "type": "array"
    }, 
    "enable_ssh": {
      "default": false, 
      "description": "Enabling SSH service is not recommended for security reasons.\n", 
      "required": false, 
      "title": "Enable SSH.", 
      "type": "boolean"
    }, 
    "host_id": {
      "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", 
      "required": false, 
      "title": "Host identifier in the specified vcenter server.", 
      "type": "string"
    }, 
    "hostname": {
      "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])?)*?$", 
      "required": true, 
      "title": "Host name or FQDN for edge node.", 
      "type": "string"
    }, 
    "management_network_id": {
      "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.\n", 
      "required": true, 
      "title": "Portgroup or logical switch identifier for management network connectivity.", 
      "type": "string"
    }, 
    "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", 
      "items": {
        "$ref": "IPSubnet"+
      }, 
      "maxItems": 1, 
      "minItems": 1, 
      "required": false, 
      "title": "Port subnets for management port. Only one IPv4 Address is supported.", 
      "type": "array"
    }, 
    "ntp_servers": {
      "description": "List of NTP servers.\n", 
      "items": {
        "$ref": "IPAddress"+
      }, 
      "required": false, 
      "title": "NTP servers.", 
      "type": "array"
    }, 
    "placement_type": {
      "enum": [
        "VsphereDeploymentConfig"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "search_domains": {
      "description": "List of domain names that are used to complete unqualified host names.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Search domain names.", 
      "type": "array"
    }, 
    "storage_id": {
      "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", 
      "required": true, 
      "title": "Storage/datastore identifier in the specified vcenter server.", 
      "type": "string"
    }, 
    "vc_id": {
      "description": "The vc specific identifiers will be resolved on this VC.\nSo all other identifiers specified here must belong to this vcenter server.\n", 
      "required": true, 
      "title": "Vsphere compute identifier for identifying the vcenter server.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VtepCsvListResult (type) 

{
  "extends": {
    "$ref": "CsvListResult"+
  }, 
  "id": "VtepCsvListResult", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "file_name": {
      "description": "File name set by HTTP server if API  returns CSV result as a file.", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "results": {
      "items": {
        "$ref": "VtepTableCsvRecord"+
      }, 
      "required": false, 
      "type": "array"
    }
  }, 
  "type": "object"
}

VtepLabelPool (type) 

{
  "additionalProperties": false, 
  "description": "A collection of ranges of virtual tunnel endpoint labels", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "VtepLabelPool", 
  "module_id": "VtepLabel", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "pool_usage": {
      "$ref": "VtepLabelPoolUsage"+, 
      "readonly": true, 
      "title": "Pool usage statistics"
    }, 
    "ranges": {
      "items": {
        "$ref": "VtepLabelRange"+
      }, 
      "required": true, 
      "title": "Array of ranges for virtual tunnel endpoint labels", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

VtepLabelPoolListResult (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "VtepLabelPoolListResult", 
  "module_id": "VtepLabel", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VtepLabelPool"+
      }, 
      "required": true, 
      "title": "Virtual tunnel endpoint label pool list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VtepLabelPoolUsage (type) 

{
  "additionalProperties": false, 
  "description": "Pool usage statistics in a pool", 
  "id": "VtepLabelPoolUsage", 
  "module_id": "VtepLabel", 
  "properties": {
    "allocated_ids": {
      "readonly": true, 
      "title": "Total number of allocated IDs in a pool", 
      "type": "integer"
    }, 
    "free_ids": {
      "readonly": true, 
      "title": "Total number of free IDs in a pool", 
      "type": "integer"
    }, 
    "total_ids": {
      "readonly": true, 
      "title": "Total number of IDs in a pool", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

VtepLabelRange (type) 

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "VtepLabelRange", 
  "module_id": "VtepLabel", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "end": {
      "description": "End value for virtual tunnel endpoint label range", 
      "maximum": 131071, 
      "minimum": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Virtual tunnel endpoint label range end", 
      "type": "integer"
    }, 
    "start": {
      "description": "Start value for virtual tunnel endpoint label range", 
      "maximum": 131071, 
      "minimum": 1, 
      "readonly": false, 
      "required": true, 
      "title": "Virtual tunnel endpoint label range start", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

VtepListResult (type) 

{
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "VtepListResult", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cursor": {
      "readonly": true, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "last_update_timestamp": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "Timestamp when the data was last updated; unset if data source has never updated the data.", 
      "readonly": true
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the logical Switch", 
      "type": "string"
    }, 
    "result_count": {
      "readonly": true, 
      "title": "Count of results found (across all pages), set only on first page", 
      "type": "integer"
    }, 
    "results": {
      "items": {
        "$ref": "VtepTableEntry"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "title": "If true, results are sorted in ascending order", 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_id": {
      "readonly": true, 
      "required": false, 
      "title": "Transport node identifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VtepTableCsvRecord (type) 

{
  "extends": {
    "$ref": "CsvRecord"+
  }, 
  "id": "VtepTableCsvRecord", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "segment_id": {
      "required": false, 
      "title": "The segment Id", 
      "type": "string"
    }, 
    "vtep_ip": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "The virtual tunnel endpoint IP address"
    }, 
    "vtep_label": {
      "required": true, 
      "title": "The virtual tunnel endpoint label", 
      "type": "integer"
    }, 
    "vtep_mac_address": {
      "required": true, 
      "title": "The virtual tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VtepTableEntry (type) 

{
  "id": "VtepTableEntry", 
  "module_id": "AggSvcLogicalSwitch", 
  "properties": {
    "segment_id": {
      "required": false, 
      "title": "The segment Id", 
      "type": "string"
    }, 
    "vtep_ip": {
      "$ref": "IPAddress"+, 
      "required": false, 
      "title": "The virtual tunnel endpoint IP address"
    }, 
    "vtep_label": {
      "required": false, 
      "title": "The virtual tunnel endpoint label", 
      "type": "integer"
    }, 
    "vtep_mac_address": {
      "required": false, 
      "title": "The virtual tunnel endpoint MAC address", 
      "type": "string"
    }
  }, 
  "type": "object"
}

WeeklyBackupSchedule (type) 

{
  "extends": {
    "$ref": "BackupSchedule"+
  }, 
  "id": "WeeklyBackupSchedule", 
  "module_id": "BackupConfiguration", 
  "polymorphic-type-descriptor": {
    "type-identifier": "WeeklyBackupSchedule"
  }, 
  "properties": {
    "days_of_week": {
      "items": {
        "type": "integer"
      }, 
      "maxItems": 7, 
      "minItems": 1, 
      "required": true, 
      "title": "Days of week when backup is taken. 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday ...", 
      "type": "array", 
      "uniqueItems": true
    }, 
    "hour_of_day": {
      "maximum": 23, 
      "minimum": 0, 
      "required": true, 
      "title": "Time of day when backup is taken", 
      "type": "integer"
    }, 
    "minute_of_day": {
      "maximum": 59, 
      "minimum": 0, 
      "required": true, 
      "title": "Time of day when backup is taken", 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "WeeklyBackupSchedule", 
        "IntervalBackupSchedule"
      ], 
      "required": true, 
      "title": "Schedule type", 
      "type": "string"
    }
  }, 
  "title": "Schedule to specify day of the week and time to take automated backup", 
  "type": "object"
}

WeeklyTelemetrySchedule (type) 

{
  "extends": {
    "$ref": "TelemetrySchedule"+
  }, 
  "id": "WeeklyTelemetrySchedule", 
  "module_id": "TelemetryConfig", 
  "polymorphic-type-descriptor": {
    "type-identifier": "WeeklyTelemetrySchedule"
  }, 
  "properties": {
    "day_of_week": {
      "description": "Day of week on which data will be collected. Specify one of SUNDAY through SATURDAY.\n", 
      "enum": [
        "SUNDAY", 
        "MONDAY", 
        "TUESDAY", 
        "WEDNESDAY", 
        "THURSDAY", 
        "FRIDAY", 
        "SATURDAY"
      ], 
      "required": true, 
      "title": "Day of week on which data will be collected", 
      "type": "string"
    }, 
    "frequency_type": {
      "description": "Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.", 
      "required": true, 
      "title": "Frequency at which data will be collected", 
      "type": "string"
    }, 
    "hour_of_day": {
      "description": "Hour at which data will be collected. Specify a value between 0 through 23.\n", 
      "maximum": 23, 
      "minimum": 0, 
      "required": true, 
      "title": "Hour at which data will be collected", 
      "type": "integer"
    }, 
    "minutes": {
      "default": 0, 
      "description": "Minute at which data will be collected. Specify a value between 0 through 59.\n", 
      "maximum": 59, 
      "minimum": 0, 
      "required": false, 
      "title": "Minute at which data will be collected", 
      "type": "integer"
    }
  }, 
  "type": "object"
}

WhiteListProvisionType (type) 

{
  "enum": [
    "LPORT_BINDINGS", 
    "LSWITCH_BINDINGS"
  ], 
  "id": "WhiteListProvisionType", 
  "module_id": "SpoofGuardSwitchingProfile", 
  "title": "Ways to provide white listed addresses for SpoofGuard", 
  "type": "string"
}

WidgetConfiguration (type) 

{
  "additionalProperties": false, 
  "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.", 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "WidgetConfiguration", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "polymorphic-type-descriptor": {
    "mode": "enabled"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp"+, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "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", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "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.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "datasources": {
      "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.", 
      "items": {
        "$ref": "Datasource"+
      }, 
      "minItems": 0, 
      "title": "Array of Datasource Instances with their relative urls", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Title of the widget.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Widget Title", 
      "type": "string"
    }, 
    "drilldown_id": {
      "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.", 
      "maxLength": 255, 
      "title": "Id of drilldown widget", 
      "type": "string"
    }, 
    "footer": {
      "$ref": "Footer"+
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "is_drilldown": {
      "default": false, 
      "description": "Set to true if this widget should be used as a drilldown.", 
      "title": "Set as a drilldown widget", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.", 
      "enum": [
        "LabelValueConfiguration", 
        "DonutConfiguration", 
        "MultiWidgetConfiguration", 
        "ContainerConfiguration", 
        "StatsConfiguration", 
        "GridConfiguration"
      ], 
      "maxLength": 255, 
      "readonly": true, 
      "required": true, 
      "title": "Widget visualization type", 
      "type": "string"
    }, 
    "shared": {
      "deprecated": true, 
      "description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.", 
      "title": "Visiblity of widgets to other users", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "weight": {
      "deprecated": true, 
      "description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.", 
      "title": "Weightage or placement of the widget or container", 
      "type": "int"
    }
  }, 
  "title": "Dashboard Widget Configuration", 
  "type": "object"
}

WidgetItem (type) 

{
  "additionalProperties": false, 
  "description": "Represents a reference to a widget that is held by a container or a multi-widget or a View.", 
  "id": "WidgetItem", 
  "module_id": "NsxDashboard", 
  "nsx_feature": "NsxDashboardWidgetConfig", 
  "properties": {
    "label": {
      "$ref": "Label"+, 
      "description": "Applicable for 'DonutConfiguration' and 'StatsConfiguration' reports only. If label is not specified, then it defaults to the label of the donut or stats report.", 
      "title": "Label of the the report"
    }, 
    "weight": {
      "default": 10000, 
      "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", 
      "type": "int"
    }, 
    "widget_id": {
      "description": "Id of the widget configuration that is held by a multi-widget or a container or a view.", 
      "maxLength": 255, 
      "required": true, 
      "title": "Id of the widget configuration", 
      "type": "string"
    }
  }, 
  "title": "Widget held by MultiWidgetConfiguration or Container or a View", 
  "type": "object"
}

X509Certificate (type) 

{
  "additionalProperties": false, 
  "id": "X509Certificate", 
  "module_id": "CertificateManager", 
  "properties": {
    "dsa_public_key_g": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters, base", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "dsa_public_key_p": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters, prime", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "dsa_public_key_q": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters, sub-prime", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "dsa_public_key_y": {
      "description": "One of the DSA cryptogaphic algorithm's strength parameters", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "is_ca": {
      "description": "True if this is a CA certificate", 
      "readonly": true, 
      "required": true, 
      "type": "boolean"
    }, 
    "is_valid": {
      "description": "True if this certificate is valid", 
      "readonly": true, 
      "required": true, 
      "type": "boolean"
    }, 
    "issuer": {
      "description": "the certificate issuers complete distinguished name", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "issuer_cn": {
      "description": "the certificate issuer's common name", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "not_after": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "the time in epoch milliseconds at which the certificate becomes invalid", 
      "readonly": true, 
      "required": true
    }, 
    "not_before": {
      "$ref": "EpochMsTimestamp"+, 
      "description": "the time in epoch milliseconds at which the certificate becomes valid", 
      "readonly": true, 
      "required": true
    }, 
    "public_key_algo": {
      "description": "Cryptographic algorithm used by the public key for data encryption", 
      "enum": [
        "RSA", 
        "DSA"
      ], 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "public_key_length": {
      "description": "size measured in bits of the public/private keys used in a cryptographic algorithm", 
      "readonly": true, 
      "required": true, 
      "type": "integer"
    }, 
    "rsa_public_key_exponent": {
      "description": "An RSA public key is made up of the modulus and the public exponent. Exponent is a power number", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "rsa_public_key_modulus": {
      "description": "An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "serial_number": {
      "description": "certificate's serial number", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "signature": {
      "description": "the signature value(the raw signature bits) used for signing and validate the cert", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "signature_algorithm": {
      "description": "the algorithm used by the Certificate Authority to sign the certificate", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "subject": {
      "description": "the certificate owners complete distinguished name", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "subject_cn": {
      "description": "the certificate owner's common name", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "version": {
      "description": "Certificate version (default v1)", 
      "readonly": true, 
      "required": true, 
      "type": "string"
    }
  }, 
  "type": "object"
}

X509Crl (type) 

{
  "additionalProperties": false, 
  "id": "X509Crl", 
  "module_id": "CertificateManager", 
  "properties": {
    "crl_entries": {
      "description": "list of X509CrlEntry", 
      "items": {
        "$ref": "X509CrlEntry"+
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "issuer": {
      "description": "Issuer's distinguished name(DN)", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "next_update": {
      "description": "Next update time for the CRL", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "version": {
      "description": "CRL's version number either 1 or 2", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "title": "A CRL is a time-stamped list identifying revoked certificates.", 
  "type": "object"
}

X509CrlEntry (type) 

{
  "additionalProperties": false, 
  "id": "X509CrlEntry", 
  "module_id": "CertificateManager", 
  "properties": {
    "revocation_date": {
      "description": "Revocation date", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }, 
    "serial_number": {
      "description": "the revoked certificate's serial number", 
      "readonly": true, 
      "required": false, 
      "type": "string"
    }
  }, 
  "title": "Each revoked certificate is identified in a CRL by its certificate serial number.", 
  "type": "object"
}

XForwardedForType (type) 

{
  "additionalProperties": false, 
  "enum": [
    "INSERT", 
    "REPLACE"
  ], 
  "id": "XForwardedForType", 
  "module_id": "LoadBalancer", 
  "title": "x-forwarded-for type", 
  "type": "string"
}


API Errors

301 - Moved Permanently

Request must be reissued to a different controller node.

The controller node has been replaced by a new node that should be used for this and all future requests.

Response Code 301 Moved Permanently
Response Headers Content-Type: text/plain
Location: <URI for new request>
Response Body Additional information about the error, if available.

303 - See Other

The response to the request can be found under a different URI identified by the Location response header.

Response Code 303 See Other
Response Headers Content-Type: text/plain
Location: <URI for new request>
Response Body Additional information about the error, if available.

307 - Temporary Redirect

Request should be reissued to a different controller node.

The controller node is requesting the client make further requests against the controller node specified in the Location header. Clients should continue to use the new server until directed otherwise by the new controller node.

Response Code 307 Temporary Redirect
Response Headers Content-Type: text/plain
Location: <URI for new request>
Response Body Additional information about the error, if available.

400 - Bad Request

Request was improperly formatted or contained an invalid parameter.

Response Code 400 Bad Request
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

401 - Unauthorized

Response Code 401 Unauthorized
Response Headers
Response Body Additional information about the error, if available.

403 - Forbidden

The client does not have sufficient privileges to execute the request.

The API is likely in read-only mode, or a request was made to modify a read-only property.

Response Code 403 Forbidden
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

404 - Not Found

An entity referenced in the request does not exist.

Create the referenced resource first, then reissue the request.

Response Code 404 Not Found
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

409 - Conflict

The request can not be performed because it conflicts with configuration on a different entity.

Modify the conflicting configuration, then reissue the request.

Response Code 409 Conflict
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

410 - Gone

Response Code 410 Gone
Response Headers
Response Body Additional information about the error, if available.

500 - Internal Server Error

An internal error occurred while executing the request. If the problem persists, perform diagnostic system tests, or contact your support representative.

Response Code 500 Internal Server Error
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

502 - Bad Gateway

Response Code 502 Bad Gateway
Response Headers
Response Body Additional information about the error, if available.

503 - Service Unavailable

The request can not be performed because the associatedresource could not be reached or is temporarily busy. Verify theassociated resource is connected, then reissue the request.

Response Code 503 Service Unavailable
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

504 - Gateway Timeout

Response Code 504 Gateway Timeout
Response Headers
Response Body Additional information about the error, if available.