NSX Policy API Guide

NSX 2.1.0

Table of Contents

  1. Overview
  2. API Methods
    1. Api Services
      1. Authentication
    2. Licensing
    3. Nsx Component Administration
      1. Appliance Management
      2. Backup Restore Management
        1. Restore
    4. Policy
      1. Infra
      2. Realization
      3. Template
    5. Troubleshooting And Monitoring
      1. System Logs
    6. Upgrade
      1. Bundle
      2. Group
      3. History
      4. Nodes
      5. Plan
      6. Status
      7. Upgradeunits
  3. API Types
  4. API Type Schemas
  5. API Errors


Overview

Introduction

NSX Policy 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 Policy 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. It is possible for requests to partially complete before failing. Any inconsistent state resulting from a failure must be resolved by the caller.

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 Policy API

You can get an OpenAPI specification of the NSX Policy API with one of the following calls:



API Methods

Toggle all tables +

Api Services

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:

Licensing

Associated URIs:

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 Management

Associated URIs:

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:

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, "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: system_administration 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:
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: crud Feature: system_administration 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: system_administration 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:

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 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:

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:

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:

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:

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:

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:

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 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+

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:
NodeServiceProperties+

Example Response: { "_schema": "NodeServiceProperties", "_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": { "communities": [ ], "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": "NodeServiceProperties", "_self": "/node/services/snmp", "service_name": "snmp" "service_properties": { "start_on_boot": false } } Required Permissions: crud Feature: system_administration 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:

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:

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 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 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_administration 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_administration 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_administration 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:

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:

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:

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:

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: Restore

Associated URIs:

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:

Policy

Associated URIs:

Read infra (Experimental)

Read infra. Returns only the infra related properties. Inner object
are not populated.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra
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:
Infra+

Required Permissions: read Additional Errors:

Update the infra including all the nested entities (Experimental)

Update the infra including all the nested entities Request:
Method:
POST
URI Path:
/policy/api/v1/infra
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
Infra+

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

Required Permissions: crud Additional Errors:

List CommunicationProfiles (Experimental)

Paginated list of CommunicationProfiles.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/communication-profiles
Request Headers:
n/a
Query Parameters:
CommunicationProfileListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read CommunicationProfile (Experimental)

Read a CommunicationProfile.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/communication-profiles/<communication-profile-id>
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:
CommunicationProfile+

Required Permissions: read Additional Errors:

Create or update a CommunicationProfile (Experimental)

Create a new CommunicationProfile if a CommunicationProfile with the given ID does not already
exist. Creates new CommunicationProfileEntries if populated in the CommunicationProfile.
If a CommunicationProfile with the given ID already exists, update the CommunicationProfile
including the nested CommunicationProfileEntries. This is a full replace.
This is the ONLY way to create CommunicationProfileEntries and to add them to a
CommunicationProfile.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/communication-profiles/<communication-profile-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CommunicationProfile+

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

Required Permissions: crud Additional Errors:

Delete CommunicationProfile (Experimental)

Delete CommunicationProfile Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/communication-profiles/<communication-profile-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: crud Additional Errors:

List CommunicationProfileEntries for CommunicationProfile (Experimental)

Paginated list of CommunicationProfileEntries for the given CommunicationProfile.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/communication-profiles/<communication-profile-id>/communication-profile-entries
Request Headers:
n/a
Query Parameters:
CommunicationProfileEntryListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Delete CommunicationProfileEntry (Experimental)

Delete CommunicationProfileEntry Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/communication-profiles/<communication-profile-id>/communication-profile-entries/<communication-profile-entry-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: crud Additional Errors:

Read CommunicationProfileEntry (Experimental)

Read CommunicationProfileEntry Request:
Method:
GET
URI Path:
/policy/api/v1/infra/communication-profiles/<communication-profile-id>/communication-profile-entries/<communication-profile-entry-id>
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:
CommunicationProfileEntry+

Required Permissions: read Additional Errors:

Create or update a CommunicationProfileEntry (Experimental)

Update the CommunicationProfileEntry. If a CommunicationProfileEntry with the communication-profile-entry-id
is not already present, this API fails with a 404. Creation of CommunicationProfileEntries
is not allowed using this API.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/communication-profiles/<communication-profile-id>/communication-profile-entries/<communication-profile-entry-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CommunicationProfileEntry+

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

Required Permissions: crud Additional Errors:

List domains for infra (Experimental)

Paginated list of all domains for infra.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains
Request Headers:
n/a
Query Parameters:
DomainListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read domain (Experimental)

Read a domain.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>
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:
Domain+

Required Permissions: read Additional Errors:

Create or update a domain (Experimental)

If a domain with the domain-id is not already present, create a new
domain. If it already exists, update the domain including the nested
groups. This is a full replace
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/domains/<domain-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
Domain+

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

Required Permissions: crud Additional Errors:

Delete Domain and all the entities contained by this domain (Experimental)

Delete the domain along with all the entities contained by this domain.
The groups that are a part of this domain are also deleted along with
the domain.
Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/domains/<domain-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: crud Additional Errors:

Read communication-map (Experimental)

Read communication-map for a domain.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>/communication-map
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:
CommunicationMap+

Required Permissions: read Additional Errors:

Update communication map (Experimental)

Update the communication map for a domain. This is a full replace.
All the CommunicationEntries are replaced.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/domains/<domain-id>/communication-map
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CommunicationMap+

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

Required Permissions: crud Additional Errors:

List CommunicationEntries (Experimental)

List CommunicationEntries Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>/communication-map/communication-entries
Request Headers:
n/a
Query Parameters:
CommunicationEntryListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read CommunicationEntry (Experimental)

Read CommunicationEntry Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>/communication-map/communication-entries/<communication-entry-id>
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:
CommunicationEntry+

Required Permissions: read Additional Errors:

Create or update a CommunicationEntry (Experimental)

Update the CommunicationEntry. If a CommunicationEntry with the communication-entry-id
is not already present, this API fails with a 404. Creation of CommunicationEntries
is not allowed using this API.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/domains/<domain-id>/communication-map/communication-entries/<communication-entry-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CommunicationEntry+

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

Required Permissions: crud Additional Errors:

Delete CommunicationEntry (Experimental)

Delete CommunicationEntry Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/domains/<domain-id>/communication-map/communication-entries/<communication-entry-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: crud Additional Errors:

Revise the positioninng of communication maps (Experimental)

This is used to set a precedence of a communication map w.r.t others.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/domains/<domain-id>/communication-map?action=revise
Request Headers:
n/a
Query Parameters:
CommunicationMapInsertParameters+
Request Body:
CommunicationMap+

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

Required Permissions: crud Additional Errors:

List Groups for a domain (Experimental)

List Groups for a domain Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>/groups
Request Headers:
n/a
Query Parameters:
GroupListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Create or update a group (Experimental)

If a group with the group-id is not already present, create a new group.
If it already exists, update the group.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/domains/<domain-id>/groups/<group-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
Group+

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

Required Permissions: crud Additional Errors:

Delete Group (Experimental)

Delete Group Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/domains/<domain-id>/groups/<group-id>
Request Headers:
n/a
Query Parameters:
GroupDeleteRequestParameters+
Request Body:
n/a

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

Required Permissions: crud Additional Errors:

Read group (Experimental)

Read group Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>/groups/<group-id>
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:
Group+

Required Permissions: read Additional Errors:

List Services for infra (Experimental)

Paginated list of Services for infra.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/services
Request Headers:
n/a
Query Parameters:
ServiceListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Delete Service (Experimental)

Delete Service Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/services/<service-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: crud Additional Errors:

Read a service (Experimental)

Read a service Request:
Method:
GET
URI Path:
/policy/api/v1/infra/services/<service-id>
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:
Service+

Required Permissions: read Additional Errors:

Create or update a Service (Experimental)

Create a new service if a service with the given ID does not already
exist. Creates new service entries if populated in the service.
If a service with the given ID already exists, update the service
including the nested service entries. This is a full replace.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/services/<service-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
Service+

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

Required Permissions: crud Additional Errors:

List Service entries for the given service (Experimental)

Paginated list of Service entries for the given service
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/services/<service-id>/service-entries
Request Headers:
n/a
Query Parameters:
ServiceEntryListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Create or update a ServiceEntry (Experimental)

If a service entry with the service-entry-id is not already present,
create a new service entry. If it already exists, update the service
entry.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/services/<service-id>/service-entries/<service-entry-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ALGTypeServiceEntry+
EtherTypeServiceEntry+
ICMPTypeServiceEntry+
IGMPTypeServiceEntry+
IPProtocolServiceEntry+
L4PortSetServiceEntry+

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

Required Permissions: crud Additional Errors:

Delete Service entry (Experimental)

Delete Service entry Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/services/<service-id>/service-entries/<service-entry-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: crud Additional Errors:

Service entry (Experimental)

Service entry Request:
Method:
GET
URI Path:
/policy/api/v1/infra/services/<service-id>/service-entries/<service-entry-id>
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:
ALGTypeServiceEntry+
EtherTypeServiceEntry+
ICMPTypeServiceEntry+
IGMPTypeServiceEntry+
IPProtocolServiceEntry+
L4PortSetServiceEntry+

Required Permissions: read Additional Errors:

Policy: Infra

Associated URIs:

List Deployment Zones for infra (Experimental)

Paginated list of all Deployment zones for infra.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/deployment-zones
Request Headers:
n/a
Query Parameters:
DeploymentZoneListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read a DeploymentZone (Experimental)

Read a Deployment Zone
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/deployment-zones/<deployment-zone-id>
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:
DeploymentZone+

Required Permissions: read Additional Errors:

List enforcementpoints for infra (Experimental)

Paginated list of all enforcementpoints for infra.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points
Request Headers:
n/a
Query Parameters:
EnforcementPointListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Delete EnforcementPoint (Experimental)

Delete EnforcementPoint Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points/<enforcementpoint-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: crud Additional Errors:

Create/update a new Enforcement Point under infra (Experimental)

If the passed Enforcement Point does not already exist, create a new Enforcement Point.
If it already exists, replace it.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points/<enforcementpoint-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
EnforcementPoint+

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

Required Permissions: crud Additional Errors:

Read an Enforcement Point (Experimental)

Read an Enforcement Point
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/deployment-zones/<deployment-zone-id>/enforcement-points/<enforcementpoint-id>
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:
EnforcementPoint+

Required Permissions: read Additional Errors:

List Domain Deployment maps for infra (Experimental)

Paginated list of all Domain Deployment Entries for infra.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps
Request Headers:
n/a
Query Parameters:
DomainDeploymentMapListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Delete Domain Deployment Map (Experimental)

Delete Domain Deployment Map Request:
Method:
DELETE
URI Path:
/policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-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: crud Additional Errors:

Create a new Domain Deployment Map under infra (Experimental)

If the passed Domain Deployment Map does not already exist, create a new Domain Deployment Map.
If it already exist, replace it.
Request:
Method:
POST
URI Path:
/policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
DomainDeploymentMap+

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

Required Permissions: crud Additional Errors:

Read a DomainDeploymentMap (Experimental)

Read a Domain Deployment Map
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/domains/<domain-id>/domain-deployment-maps/<domain-deployment-map-id>
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:
DomainDeploymentMap+

Required Permissions: read Additional Errors:

Policy: Realization

Associated URIs:

List Enforcement Points (Experimental)

Paginated list of all enforcement points. Returns the populated enforcement points.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points
Request Headers:
n/a
Query Parameters:
RealizedEnforcementPointListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read Enforcement Point (Experimental)

Read a Enforcement Point and the complete tree underneath. Returns the populated enforcement point object.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>
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:
RealizedEnforcementPoint+

Required Permissions: read Additional Errors:

List Firewall Sections (Experimental)

Paginated list of all Firewalls. Returns populated Firewalls.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/firewalls/firewall-sections
Request Headers:
n/a
Query Parameters:
RealizedFirewallSectionListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read Firewall (Experimental)

Read a Firewall and the complete tree underneath. Returns the
populated Firewall object.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/firewalls/firewall-sections/<firewall-section-id>
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:
RealizedFirewallSection+

Required Permissions: read Additional Errors:

List NS Groups (Experimental)

Paginated list of all NSGroups. Returns populated NSGroups.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/nsgroups
Request Headers:
n/a
Query Parameters:
RealizedNSGroupListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read Group (Experimental)

Read a NSGroup and the complete tree underneath. Returns the
populated NSgroup object.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/nsgroups/<nsgroup-name>
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:
RealizedNSGroup+

Required Permissions: read Additional Errors:

List Security Groups (Experimental)

Paginated list of all Security Groups. Returns populated Security Groups.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/securitygroups
Request Headers:
n/a
Query Parameters:
RealizedSecurityGroupListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read Group (Experimental)

Read a Security Group and the complete tree underneath. Returns the
populated Security Group object.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/groups/securitygroups/<securitygroup-name>
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:
RealizedSecurityGroup+

Required Permissions: read Additional Errors:

List IPSets (Experimental)

Paginated list of all Realized IPSets
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/ip-sets/ip-sets-nsxt
Request Headers:
n/a
Query Parameters:
RealizedIPSetListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read IPSet Realized state (Experimental)

Read an IPSet
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/ip-sets/ip-sets-nsxt/<ip-set-name>
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:
RealizedIPSet+

Required Permissions: read Additional Errors:

List MACSets (Experimental)

Paginated list of all Realized MACSets
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/mac-sets/mac-sets-nsxt
Request Headers:
n/a
Query Parameters:
RealizedMACSetListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read MACSet Realized state (Experimental)

Read an MACSet
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/mac-sets/mac-sets-nsxt/<mac-set-name>
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:
RealizedMACSet+

Required Permissions: read Additional Errors:

List Realized NSServices (Experimental)

Paginated list of all Realized NSService.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/services/nsservices
Request Headers:
n/a
Query Parameters:
RealizedNSServiceListRequestParameters+
Request Body:
n/a

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

Required Permissions: read Additional Errors:

Read NSService (Experimental)

Read a NSService.
Request:
Method:
GET
URI Path:
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/services/nsservices/<nsservice-name>
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:
RealizedNSService+

Required Permissions: read Additional Errors:

Policy: Template

Associated URIs:

List Policy Templates (Experimental)

List Policy Templates Request:
Method:
GET
URI Path:
/policy/api/v1/templates
Request Headers:
n/a
Query Parameters:
PolicyTemplateListRequestParameters+
Request Body:
n/a

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

Required Permissions: read-api Additional Errors:

Delete template. (Experimental)

Delete a template. Request:
Method:
DELETE
URI Path:
/policy/api/v1/templates/<template-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-write-api Additional Errors:

Read template. (Experimental)

Read a template and returns the template properties for a given template identifier.
Request:
Method:
GET
URI Path:
/policy/api/v1/templates/<template-id>
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:
PolicyTemplate+

Required Permissions: read-api Additional Errors:

Create or update a template. (Experimental)

Create a new template if the specified template id does not correspond to an existing template. Update the template
if otherwise.
Request:
Method:
POST
URI Path:
/policy/api/v1/templates/<template-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
PolicyTemplate+

Example Request: POST https://<nsx-mgr>/policy/api/v1/templates/WebAppTemplate { "_revision": 0, "display_name": "WebAppTemplate", "description": "Policy Template", "template_placeholders": [ { "placeholder_id": "", "placeholder_message": "Specify a name for domain" }, { "placeholder_id": "", "placeholder_message": "Specify a name for group 1" }, { "placeholder_id": "", "placeholder_message": "Specify a membership criteria for group 1" }, { "placeholder_id": "", "placeholder_message": "Specify a name for group 2" } ], "template_body": { "resource_type": "Infra", "_revision": 0, "display_name": "Infra", "description": "Policy Infra", "domains": [ { "_revision": 0, "display_name": "", "description": "Policy Domain", "groups": [ { "_revision": 0, "display_name": "", "description": "Policy Group", "expression": [ { "resource_type": "Condition", "member_type": "VirtualMachine", "key": "Name", "operator": "STARTSWITH", "value": "" } ] }, { "_revision": 0, "display_name": "", "description": "Policy Group", "expression": [] } ], "communication_map": { "_revision": 0, "display_name": "communication_map", "description": "Policy Communication Map", "precedence": 1, "communication_entries": [ { "_revision": 0, "display_name": "communication_entry1", "description": "Policy Communication Entry 1", "sequence_number": 1, "source_groups": [ "Any" ], "destination_groups": [ "/infra/domains//groups/" ], "communication_profile_path": "/infra/communication-profiles/AppServicesAllow" }, { "_revision": 0, "display_name": "communication_entry2", "description": "Policy Communication Entry", "sequence_number": 1, "source_groups": [ "Any" ], "destination_groups": [ "/infra/domains//groups/" ], "communication_profile_path": "/infra/communication-profiles/WebServicesAllow" } ] } } ], "communication_profiles": [ { "_revision": 0, "display_name": "AppServicesAllow", "description": "Policy Communication Profile", "communication_profile_entries": [ { "_revision": 0, "display_name": "com_profile_entry", "description": "Policy Communication Profile Entry", "services": [ "Microsoft_Exchange_2010" ], "action": "ALLOW" } ] }, { "_revision": 0, "display_name": "WebServicesAllow", "description": "Policy Communication Profile", "communication_profile_entries": [ { "_revision": 0, "display_name": "com_profile_entry1", "description": "Policy Communication Profile Entry", "services": [ "SSH", "HTTP", "HTTPS" ], "action": "ALLOW" } ] } ], "connectivity_strategy": "WHITELIST" } } Successful Response:
Response Code:
201 Created
Response Headers:
n/a
Response Body:
n/a

Required Permissions: read-write-api Additional Errors:

Deploy template. (Experimental)

Read a template, populate the placeholders' fields with the parameters' values, and deploy the template
body by creating or updating all the nested policy objects inside the AbstractSpace object.
Request:
Method:
POST
URI Path:
/policy/api/v1/templates/<template-id>?action=deploy
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
PolicyTemplateParameters+

Example Request: PUT https://<nsx-mgr>/policy/api/v1/templates/deploy/WebAppTemplate { "placeholders" : [ { "parameter_id": "", "parameter_value": "App1" }, { "parameter_id": "", "parameter_value": "WebGroup" }, { "parameter_id": "", "parameter_value": "Web" }, { "parameter_id": "", "parameter_value": "AppGroup" } ] } Successful Response:
Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Required Permissions: read-write-api 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: 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:

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_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 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 array of PortElement Maximum items: 15

ALGTypeServiceEntry (schema) (Experimental)

An ServiceEntry that represents an ALG protocol

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alg string Required
Enum: ORACLE_TNS, FTP, SUN_RPC_TCP, SUN_RPC_UDP, MS_RPC_TCP, MS_RPC_UDP, NBNS_BROADCAST, NBDG_BROADCAST
description Description of this resource string Maximum length: 1024
Sortable
destination_ports The destination_port cannot be empty and must be a single value. array of PortElement Maximum items: 15
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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value ALGTypeServiceEntry string Required
Enum: EtherTypeServiceEntry, IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry
source_ports array of PortElement Maximum items: 15
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

AboveRuleIdParameter (schema)

Name Description Type Notes
above_rule_id Uuid of rule above which this rule is to be inserted

Uuid of rule above which this rule is to be inserted
string

AbstractSpace (schema) (Experimental)

The space in which policy is being defined

Represents the space in which the policy is being defined

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
communication_profiles CommunicationProfiles under this space

This field is used while creating or updating the space.
array of CommunicationProfile
connectivity_strategy Connectivity strategy used by this tenant

This field indicates the default connectivity policy for the infra
or tenant space
WHITELIST - Adds a default drop rule. Administrator can then use "allow"
rules (aka whitelist) to allow traffic between groups
BLACKLIST - Adds a default allow rule. Admin can then use "drop" rules
(aka blacklist) to block traffic between groups
NONE - No default rules are added. This is the default setting
string Enum: WHITELIST, BLACKLIST, NONE
Default: "NONE"
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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value AbstractSpace string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

ActionDescriptor (schema)

Name Description Type Notes
description A description of what the action does string Readonly
descriptor The URI of the REST routine provider that implements the action string Required
Readonly
name The name of the action string Required
Readonly
uri The URI to use to invoke the action string Required
Readonly

ActionParameter (schema)

Name Description Type Notes
action Action to be done for the entity configuration. string Enum: retry, force-sync

AllocationTokenParameter (schema)

Name Description Type Notes
allocation_token Unique pool allocation token to ensure idempotent allocation release. string Maximum length: 64

ApiError (schema)

Name Description Type Notes
details string
error_code integer
error_data array of string
error_message string
module_name string
related_errors array of ApiError

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 string Readonly
_self 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 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 string Readonly
_self 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

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 string Readonly
_self 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.
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

BackupFile (schema)

Backup file properties

Name Description Type Notes
file_store File location string Required
Enum: local, remote
passphrase Passphrase used to encrypt backup file string Required

BackupProperties (schema)

Backup properties

Name Description Type Notes
backup_file Backup file LocalFilestoreBackupFile or RemoteFilestoreBackupFile Required

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)

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)

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)

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)

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)

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

BulkUpdateUpgradeUnitGroupsRequest (schema)

Name Description Type Notes
requests array of UpgradeUnitGroup Required

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

Certificate (schema)

Name Description Type Notes
pem_encoded PEM encoded X.509 certificate string Required
Readonly

CertificateId (schema)

Name Description Type Notes
certificate_id Certificate ID string Required
Readonly

CertificateKeyPair (schema)

Name Description Type Notes
certificate SecurityCertificate Required
rsa_private_key PEM encoded RSA private key

The private key must include the enclosing "-----BEGIN RSA PRIVATE KEY-----" and "-----END RSA PRIVATE KEY-----". An empty string is returned in read responses.
string Required
Minimum length: 60

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

ClusterRestoreStatus (schema)

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

CommunicationEntry (schema) (Experimental)

Binding of source and destination groups to a CommunicationProfile

Binding of source and destination groups to a CommunicationProfile

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
communication_profile_path Path of the CommunicationProfile participating in this map

Path of the CommunicationProfile participating in this map
string
description Description of this resource string Maximum length: 1024
Sortable
destination_groups Destination group paths

We need paths as duplicate names may exist for groups under different
domains.In order to specify all groups, use the constant "ANY". This
is case insensitive. If "ANY" is used, it should be the ONLY element
in the group array. Error will be thrown if ANY is used in conjunction
with other values.
array of string
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
logged Enable logging flag

Flag to enable packet logging. Default is disabled.
boolean Default: "False"
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value CommunicationEntry string
sequence_number Sequence number of the this CommunicationEntry

This field is used to resolve conflicts between multiple
CommunicationEntries under CommunicationMap for a Domain
int
source_groups Source group paths

We need paths as duplicate names may exist for groups under different
domains. In order to specify all groups, use the constant "ANY". This
is case insensitive. If "ANY" is used, it should be the ONLY element
in the group array. Error will be thrown if ANY is used in conjunction
with other values.
array of string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

CommunicationEntryListRequestParameters (schema) (Experimental)

CommunicationEntry 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 to result of query 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

CommunicationEntryListResult (schema) (Experimental)

Paged Collection of CommunicationEntries

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 CommunicationEntry list results array of CommunicationEntry Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

CommunicationMap (schema) (Experimental)

Contains ordered list of CommunicationEntries

Ordered list of CommunicationEntries. This object is created by default
along with the 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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
communication_entries CommunicationEntries that are a part of this CommunicationMap array of CommunicationEntry
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
path Absolute path of this object

Absolute path of this object
string Readonly
precedence Precedence to resolve conflicts across Domains

This field is used to resolve conflicts between communication maps
across domains. In order to change the precedence of a communication
map, it is recommended to send a POST request to the following URL
/infra/domains//communication-map?action=revise
The precedence field will reflect the value of the computed precedence
upon execution of the above mentioned POST request.
For scenarios where the administrator is using a template to update
several communication maps, the only way to set the precedence is to
explicitly specify the precedence number for each communication map.
int
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value CommunicationMap string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

CommunicationMapInsertParameters (schema) (Experimental)

Parameters to tell where communication map needs to be placed

Name Description Type Notes
anchor_path The communication map path if operation is 'insert_after' or insert_before string
operation Operation string Enum: insert_top, insert_bottom, insert_after, insert_before
Default: "insert_top"

CommunicationProfile (schema) (Experimental)

Contains ordered list of CommunicationProfileEntries

List of CommunicationProfileEntries

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
communication_profile_entries CommunicationProfileEntries that are a part of this CommunicationProfile array of CommunicationProfileEntry 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value CommunicationProfile string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

CommunicationProfileEntry (schema) (Experimental)

Specifies the service along with the action

Specifies the service along with the action

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
action Action

This action will apply on the all the services specified in the
above array.
string Required
Enum: ALLOW, DROP, REJECT
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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value CommunicationProfileEntry string
sequence_number Sequence number of the this CommunicationProfileEntry

This field is used to resolve conflicts between multiple
CommunicationProfileEntries under CommunicationProfile for a Domain.
This will be used to resolve conflicts when there are multiple
CommunicationProfileEntries under a CommunicationProfile that refer
to the same Service, but have conflicting.
int
services Names of services that forms this CommunicationProfileEntry

In order to specify all services, use the constant "ANY".
This is case insensitive. If "ANY" is used, it should
be the ONLY element in the services array. Error will be thrown
if ANY is used in conjunction with other values.
array of string Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

CommunicationProfileEntryListRequestParameters (schema) (Experimental)

CommunicationProfileEntry 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 to result of query 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

CommunicationProfileEntryListResult (schema) (Experimental)

Paged Collection of CommunicationProfileEntries

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 CommunicationProfileEntry list results array of CommunicationProfileEntry Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

CommunicationProfileListRequestParameters (schema) (Experimental)

CommunicationProfile 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 to result of query 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

CommunicationProfileListResult (schema) (Experimental)

Paged Collection of CommunicationProfiles

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 CommunicationProfile list results array of CommunicationProfile Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

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 to result of query 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

Condition (schema) (Experimental)

Represents the leaf level condition

Represents the leaf level condition

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.
integer Readonly
_schema string Readonly
_self 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 Key string Required
Enum: Tag, Name
member_type Group member type string Required
Enum: VirtualMachine, LogicalPort
operator operator string Required
Enum: EQUALS, CONTAINS, STARTSWITH
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Condition string Required
Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15
value Value string Required

ConfigurationState (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
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

ConfigurationStateElement (schema)

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

ConjunctionOperator (schema) (Experimental)

Represents the operators AND or OR

Represents the operators AND or OR

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
conjunction_operator Conjunction Operator Node string Required
Enum: OR, AND
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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value ConjunctionOperator string Required
Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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"

CopyFromRemoteFileProperties (schema)

Name Description Type Notes
port Server port integer Minimum: 1
Maximum: 65535
protocol Protocol to use to copy file HttpProtocol, HttpsProtocol, ScpProtocol or 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 ScpProtocol or SftpProtocol Required
server Remote server hostname or IP address string Required
Pattern: "^[^/:]+$"
uri URI of file to copy string Required

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

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

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

DefaultRequestParameters (schema)

Default request parameters.

Name Description Type Notes
include_system_owned Perform on system resources

Flag indicating that operation should be performed on system resources too
boolean Readonly

DeleteRequestParameters (schema)

Name Description Type Notes
force Force delete the resource even if it is being used somewhere

If true, deleting the resource succeeds even if it is being
referred as a resource reference.
boolean Default: "False"

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 to result of query 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

DeploymentZone (schema) (Experimental)

Deployment zone

Logical grouping of enforcement points

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.
integer Readonly
_schema string Readonly
_self 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
enforcement_points Logical grouping of enforcement points array of EnforcementPoint
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value DeploymentZone string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

DeploymentZoneListRequestParameters (schema) (Experimental)

DeploymentZone list request parameters

DeploymentZone 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 to result of query 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

DeploymentZoneListResult (schema) (Experimental)

Paged Collection of Deployment Zones

Paged Collection of Deployment Zones

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 Deployment Zones array of DeploymentZone Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

DiscoveredResource (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 string Readonly
_self 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: 15

Domain (schema) (Experimental)

Domain

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
communication_map CommunicationMap for this Domain

This field is used while creating or updating the CommunicationMap.
CommunicationMap
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
groups Groups under this Domain

This field is used while creating or updating the Domain.
Please take a look at the UpdateTenant API documentation for details.
array of Group
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Domain string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

DomainDeploymentMap (schema) (Experimental)

Domain deployment map

Binding of domains to the enforcement point.

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.
integer Readonly
_schema string Readonly
_self 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
enforcement_point_path Absolute path of enforcement point

Path of enforcement point on which domain will be deployed
string Required
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value DomainDeploymentMap string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

DomainDeploymentMapListRequestParameters (schema) (Experimental)

DomainDeploymentMap list request parameters

DomainDeploymentMap 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 to result of query 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

DomainDeploymentMapListResult (schema) (Experimental)

Paged Collection of Domain Deployment map

Paged Collection of Domain Deployment map

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 Deployment Map array of DomainDeploymentMap Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

DomainListRequestParameters (schema) (Experimental)

Domain 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 to result of query 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

DomainListResult (schema) (Experimental)

Paged Collection of Domains

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 list results array of Domain Required
sort_ascending 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

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

EmbeddedResource (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 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.
integer Readonly
_schema string Readonly
_self 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

EnforcementPoint (schema) (Experimental)

Represents endpoint where policy will be applied

Represents endpoint where policy will be applied

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
connection_info Enforcement point connection info EnforcementPointConnectionInfo
(Abstract type: pass one of the following concrete types)
NSXTConnectionInfo
NSXVConnectionInfo
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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value EnforcementPoint string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15
version Version of the Enforcement point string Readonly

EnforcementPointConnectionInfo (schema) (Experimental)

Enforcement point connection info

Contains information required to connect to enforcement point This is an abstract type. Concrete child types:
NSXTConnectionInfo
NSXVConnectionInfo

Name Description Type Notes
enforcement_point_address Address of the Enforcement point string
resource_type string Required
Enum: NSXTConnectionInfo, NSXVConnectionInfo

EnforcementPointListRequestParameters (schema) (Experimental)

EnforcementPoint list request parameters

EnforcementPoint 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 to result of query 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

EnforcementPointListResult (schema) (Experimental)

Paged Collection of EnforcementPoints

Paged collection of enforcement points

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 EnforcementPoint list results array of EnforcementPoint Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

EpochMsTimestamp (schema)

Timestamp in milliseconds since epoch

Name Description Type Notes
EpochMsTimestamp Timestamp in milliseconds since epoch integer

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

EtherTypeServiceEntry (schema) (Experimental)

A ServiceEntry that represents an ethertype protocol

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.
integer Readonly
_schema string Readonly
_self 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
ether_type Type of the encapsulated protocol integer Required
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value EtherTypeServiceEntry string Required
Enum: EtherTypeServiceEntry, IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

Expression (schema) (Experimental)

Base class for each node of the expression

All the nodes of the expression extend from this abstract class. This
is present for extensibility.
This is an abstract type. Concrete child types:
Condition
ConjunctionOperator
IPAddressExpression
MACAddressExpression
NestedExpression

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Expression string Required
Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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

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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self 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 boolean Readonly
sort_by Field by which records are sorted string Readonly

FileRequestHeaders (schema)

File request headers

Header definition for requests to transfer files.

Name Description Type Notes
Range 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 string Readonly
_self SelfResourceLink Readonly
name File name string Required
Pattern: "^[^/]+$"
sha1 File's SHA1 thumbprint string Required
sha256 File's SHA256 thumbprint string Required

GlobalRestoreStatus (schema)

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

Group (schema) (Experimental)

Group

Group

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.
integer Readonly
_schema string Readonly
_self 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
expression Expression

Expression
array of Expression
(Abstract type: pass one of the following concrete types)
Condition
ConjunctionOperator
IPAddressExpression
MACAddressExpression
NestedExpression
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Group string
state Realization state of this group string Enum: IN_PROGRESS, SUCCESS, FAILURE
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

GroupDeleteRequestParameters (schema) (Experimental)

Group delete request parameters

Name Description Type Notes
force Force delete the resource even if it is being used somewhere

If true, deleting the resource succeeds even if it is being
referred as a resource reference.
boolean Default: "False"

GroupListRequestParameters (schema) (Experimental)

Group 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 to result of query 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

GroupListResult (schema) (Experimental)

Paged Collection of 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 string Readonly
_self 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 Group list results array of Group Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

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 to result of query 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

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 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])?)*\.?$"

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 Protocol name string Required
Enum: http

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
connection_timeout NSX connection timeout, set to 0 to configure no timeout integer Minimum: 0
Maximum: 2147483647
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 Protocol name string Required
Enum: https
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 string Required
Enum: ICMPv4, ICMPv6
resource_type Must be set to the value ICMPTypeNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

ICMPTypeServiceEntry (schema) (Experimental)

A ServiceEntry that represents IPv4 or IPv6 ICMP protocol

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.
integer Readonly
_schema string Readonly
_self 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
icmp_code ICMP message code integer
icmp_type ICMP message type integer
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
protocol string Required
Enum: ICMPv4, ICMPv6
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value ICMPTypeServiceEntry string Required
Enum: EtherTypeServiceEntry, IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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

IGMPTypeServiceEntry (schema) (Experimental)

A ServiceEntry that represents IGMP protocol

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value IGMPTypeServiceEntry string Required
Enum: EtherTypeServiceEntry, IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

IPAddress (schema)

IPv4 or IPv6 address

Name Description Type Notes
IPAddress IPv4 or IPv6 address string

IPAddressExpression (schema) (Experimental)

IP address expression node

Represents IP address expressions in the form of an array, to support addition of IP addresses in a group.

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.
integer Readonly
_schema string Readonly
_self 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 Array of IP addresses

This array can consist of a single IP address, IP address range or a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and IPv6 addresses within one expression is not allowed. 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.
array of IPElement Required
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value IPAddressExpression string Required
Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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

IPProtocolNSService (schema)

An NSService element that represents an IP protocol

Name Description Type Notes
protocol_number integer Required
resource_type Must be set to the value IPProtocolNSService string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

IPProtocolServiceEntry (schema) (Experimental)

A ServiceEntry that represents an IP protocol

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
protocol_number integer Required
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value IPProtocolServiceEntry string Required
Enum: EtherTypeServiceEntry, IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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

IPv6Address (schema)

IPv6 address

Name Description Type Notes
IPv6Address IPv6 address string

IncludedFieldsParameters (schema)

Name Description Type Notes
included_fields Comma separated list of fields that should be included to result of query string

Infra (schema) (Experimental)

Infra

Infra space related policy

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
communication_profiles CommunicationProfiles under this space

This field is used while creating or updating the space.
array of CommunicationProfile
connectivity_strategy Connectivity strategy used by this tenant

This field indicates the default connectivity policy for the infra
or tenant space
WHITELIST - Adds a default drop rule. Administrator can then use "allow"
rules (aka whitelist) to allow traffic between groups
BLACKLIST - Adds a default allow rule. Admin can then use "drop" rules
(aka blacklist) to block traffic between groups
NONE - No default rules are added. This is the default setting
string Enum: WHITELIST, BLACKLIST, NONE
Default: "NONE"
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
domains Domains for infra

This field is used while creating or updating the infra space.
array of Domain
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Infra string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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

InstructionInfo (schema)

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

InterfaceStatistics (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 string Readonly
_self 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

KeyValuePair (schema)

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"

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 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 array of PortElement Maximum items: 15

L4PortSetServiceEntry (schema) (Experimental)

An ServiceEntry 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
_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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
description Description of this resource string Maximum length: 1024
Sortable
destination_ports array of PortElement Required
Maximum items: 15
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
l4_protocol string Required
Enum: TCP, UDP
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value L4PortSetServiceEntry string Required
Enum: EtherTypeServiceEntry, IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry
source_ports array of PortElement Maximum items: 15
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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 to result of query 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)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 boolean Readonly
sort_by Field by which records are sorted string Readonly

ListResultQueryParameters (schema)

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 to result of query 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

LocalFilestoreBackupFile (schema)

Local file store backup file

Name Description Type Notes
file_store File location string Required
Enum: local
name File name string Pattern: "^[^/]+$"
passphrase Passphrase used to encrypt backup file string Required

LoggingServiceProperties (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 PackageLoggingLevels

LoginCredential (schema)

Name Description Type Notes
credential_type Login credential, for example username-password-thumbprint or certificate based, etc 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}))$"

MACAddressExpression (schema) (Experimental)

MAC address expression node

Represents MAC address expressions in the form of an array, to support addition of MAC addresses in a group.

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.
integer Readonly
_schema string Readonly
_self 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 Array of MAC addresses

This array can consist of one or more MAC addresses.
array of MACAddress Required
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value MACAddressExpression string Required
Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

ManagedResource (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.
integer Readonly
_schema string Readonly
_self 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: 15

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 string Readonly
_self SelfResourceLink Readonly
enabled Enabled can be True/False boolean
status current status of Mandatory Access Control string Readonly
Enum: ENABLED, DISABLED, ENABLED_PENDING_REBOOT

MsgClientInfo (schema)

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

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 string Required
Enum: EtherTypeNSService, IPProtocolNSService, IGMPTypeNSService, ICMPTypeNSService, ALGTypeNSService, L4PortSetNSService

NSXTConnectionInfo (schema) (Experimental)

Credential info to connect to NSXT enforcement type

Name Description Type Notes
enforcement_point_address Address of the Enforcement point string
password Password string Required
resource_type Must be set to the value NSXTConnectionInfo string Required
Enum: NSXTConnectionInfo, NSXVConnectionInfo
thumbprint Thumbprint of Enforcement Point

Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex.
string Required
username UserName string Required

NSXVConnectionInfo (schema) (Experimental)

Credential info to connect to NSXV enforcement type

Name Description Type Notes
enforcement_point_address Address of the Enforcement point string
password Password string Required
resource_type Must be set to the value NSXVConnectionInfo string Required
Enum: NSXTConnectionInfo, NSXVConnectionInfo
thumbprint Thumbprint of Enforcement Point

Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex.
string Required
username UserName string Required

NestedExpression (schema) (Experimental)

NestedExpression

NestedExpression

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.
integer Readonly
_schema string Readonly
_self 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
expressions Expression

Expression
array of Expression
(Abstract type: pass one of the following concrete types)
Condition
ConjunctionOperator
IPAddressExpression
MACAddressExpression
NestedExpression
id Unique identifier of this resource string Readonly
Sortable
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value NestedExpression string Required
Enum: Condition, ConjunctionOperator, NestedExpression, IPAddressExpression, MACAddressExpression
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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

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 string Readonly
_self SelfResourceLink Readonly
service_name Service name string Required
service_properties HTTP Service properties HttpServiceProperties

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 string Readonly
_self 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 to result of query 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 string Readonly
_self 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 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 string Readonly
_self SelfResourceLink Readonly
service_name Service name string Required
service_properties install-upgrade Service properties InstallUpgradeServiceProperties

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 string Readonly
_self SelfResourceLink Readonly
interface_id Interface ID string Readonly
rx_bytes Number of bytes received integer Readonly
rx_dropped Number of packets dropped integer Readonly
rx_errors Number of receive errors integer Readonly
rx_frame Number of framing errors integer Readonly
rx_packets Number of packets received integer Readonly
tx_bytes Number of bytes transmitted integer Readonly
tx_carrier Number of carrier losses detected integer Readonly
tx_colls Number of collisions detected integer Readonly
tx_dropped Number of packets dropped integer Readonly
tx_errors Number of transmit errors integer Readonly
tx_packets Number of packets transmitted integer 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 string Readonly
_self 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 string Readonly
_self 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 boolean Readonly
sort_by Field by which records are sorted string Readonly

NodeLogPropertyHeaders (schema)

Node log property headers

Name Description Type Notes
NodeLogPropertyHeaders Node log property headers object

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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self 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 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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self 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 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 string Readonly
_self 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
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
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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self 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 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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self 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 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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self SelfResourceLink Readonly
service_name Service name string Required
service_properties SSH Service properties SshServiceProperties

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 string Readonly
_self 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
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 string Readonly
_self 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 string Readonly
_self 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 string Readonly
_self 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 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 string Readonly
_self 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 string Readonly
_self 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 boolean Readonly
sort_by Field by which records are sorted string Readonly

NtpServiceProperties (schema)

NTP Service properties

Name Description Type Notes
servers NTP servers array of HostnameOrIPv4Address 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 string Required
Readonly
rel Link relation type

Custom relation type (follows RFC 5988 where appropriate definitions exist)
string Required
Readonly

PackageLoggingLevels (schema)

Name Description Type Notes
logging_level Logging levels per package string Enum: ERROR, WARN, INFO, DEBUG, TRACE
package_name Package name string

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: "^.+$"

PerStepRestoreStatus (schema)

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

PolicyAlarmResource (schema) (Experimental)

Alarm base class of realized policy object

Alarm base class of realized policy object

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.
integer Readonly
_schema string Readonly
_self 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 error id for the alarm string
message error message to describe the issue string
path path of the alarm object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value PolicyAlarmResource string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

PolicyConfigResource (schema) (Experimental)

Represents an object on the desired state

Represents an object on the desired state

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value PolicyConfigResource string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

PolicyNode (schema)

PolicyNode

Representation of a policy node

Name Description Type Notes
attributes array of PolicyNodeProperty
children children of this node

None
array of PolicyNode
id id of the node string

PolicyNodeProperty (schema)

PolicyNodeProperty

Representation of a policy node property

Name Description Type Notes
key key of the property string
value value of the property string

PolicyRealizedResource (schema) (Experimental)

Abstract base class for all the realized policy objects

Abstract base class for all the realized policy objects

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value PolicyRealizedResource string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

PolicyResource (schema) (Experimental)

Abstract base class for all the policy objects

Abstract base class for all the policy objects

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value PolicyResource string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

PolicyRoot (schema) (Experimental)

Represents the root of the policy tree

Represents the root of the policy tree

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value PolicyRoot string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

PolicyTemplate (schema) (Experimental)

Policy 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.
integer Readonly
_schema string Readonly
_self 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 PolicyTemplate string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15
template_body Template Body AbstractSpace Required
template_placeholders Template placeholders array of PolicyTemplatePlaceholder Required

PolicyTemplateListRequestParameters (schema) (Experimental)

Policy Template 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 to result of query 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

PolicyTemplateListResult (schema) (Experimental)

Paged Collection of Policy Templates

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 Policy Template list results array of PolicyTemplate Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

PolicyTemplateParameter (schema) (Experimental)

Policy template parameter

Name Description Type Notes
parameter_id Parameter id string Required
parameter_value Parameter value string Required

PolicyTemplateParameters (schema) (Experimental)

Policy template parameters

Name Description Type Notes
placeholders List of Policy template parameter array of PolicyTemplateParameter Required

PolicyTemplatePlaceholder (schema) (Experimental)

Policy template placeholdder

Name Description Type Notes
placeholder_id Placeholder id string Required
placeholder_message Placeholder message string Required

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

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

Protocol (schema)

Name Description Type Notes
name Protocol name string Required

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

RealizedEnforcementPoint (schema) (Experimental)

Realized Enforcement Point

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
realized_firewalls Root of Realized Firewalls RealizedFirewalls Readonly
realized_groups Root of Realized Groups RealizedGroups Readonly
realized_services Root of Realized Services RealizedServices Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedEnforcementPoint string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedEnforcementPointListRequestParameters (schema) (Experimental)

Realized enforcement point 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 to result of query 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

RealizedEnforcementPointListResult (schema) (Experimental)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 Enforcement Point's array of RealizedEnforcementPoint
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedFirewall (schema) (Experimental)

Realized firewall

This is an abstract type. Concrete child types:
RealizedFirewallSection

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedFirewall string Required
Enum: RealizedFirewallSection
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedFirewallRule (schema) (Experimental)

Realized Firewall Rule

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
action Action

Action enforced on the packets which matches the firewall rule.
string Readonly
Enum: ALLOW, DROP, REJECT
alarms Alarm info detail array of PolicyAlarmResource
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 Readonly
Maximum items: 128
direction Rule direction

Rule direction in case of stateless firewall rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified.
string Readonly
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 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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedFirewallRule string
services Service List

List of the services. Null will be treated as any.
array of ResourceReference Readonly
Maximum items: 128
sources Source List

List of sources. Null will be treated as any.
array of ResourceReference Readonly
Maximum items: 128
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedFirewallSection (schema) (Experimental)

Realized Firewall section

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedFirewallSection string Required
Enum: RealizedFirewallSection
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.
array of RealizedFirewallRule Readonly
section_type Section Type

Type of the rules which a section can contain.
string Readonly
Enum: LAYER2, LAYER3
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedFirewallSectionListRequestParameters (schema) (Experimental)

Realized firewall section 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 to result of query 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

RealizedFirewallSectionListResult (schema) (Experimental)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 firewall sections array of RealizedFirewallSection Readonly
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedFirewallUIResource (schema)

Realized Firewall Sections and associated communication map

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.
integer Readonly
_schema string Readonly
_self 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
intent_communication_map CommunicationMap
path Absolute path of this object

Absolute path of this object
string Readonly
realized_firewall_sections Realized firewall sections associated to the communication map array of RealizedFirewall
(Abstract type: pass one of the following concrete types)
RealizedFirewallSection
Required
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedFirewallUIResource string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedFirewallUIResourceListResult (schema)

Paged Collection of communication map and Realized Firewall Sections 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 string Readonly
_self 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 communication map and realized firewall sections list results array of RealizedFirewallUIResource Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedFirewalls (schema) (Experimental)

Realized firewalls

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
realized_firewalls list of realized firewalls array of RealizedFirewall
(Abstract type: pass one of the following concrete types)
RealizedFirewallSection
Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedFirewalls string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedGroup (schema) (Experimental)

Realized group

This is an abstract type. Concrete child types:
RealizedNSGroup
RealizedSecurityGroup

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedGroup string Required
Enum: RealizedNSGroup, RealizedSecurityGroup
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedGroupUIResource (schema)

Realized Groups and associated Intent Group

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.
integer Readonly
_schema string Readonly
_self 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
intent_group Group
path Absolute path of this object

Absolute path of this object
string Readonly
realized_groups Realized groups associated to the intent group array of RealizedGroup
(Abstract type: pass one of the following concrete types)
RealizedNSGroup
RealizedSecurityGroup
Required
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedGroupUIResource string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedGroupUIResourceListResult (schema)

Paged Collection of Intent and Realized Group 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 string Readonly
_self 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 Intent and realized group list results array of RealizedGroupUIResource Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedGroups (schema) (Experimental)

Realized groups

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
realized_groups list of realized groups array of RealizedGroup
(Abstract type: pass one of the following concrete types)
RealizedNSGroup
RealizedSecurityGroup
Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedGroups string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedIPSet (schema) (Experimental)

Realized IPSet

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedIPSet string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedIPSetListRequestParameters (schema) (Experimental)

Realized 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 to result of query 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

RealizedIPSetListResult (schema) (Experimental)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 Realized IPSets array of RealizedIPSet
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedLogicalPort (schema) (Experimental)

Realized Logical 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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
logical_port_id The id of the logical port string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedLogicalPort string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
status The Operational status of the logical port string Readonly
Enum: UP, DOWN, UNKNOWN
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedLogicalSwitch (schema) (Experimental)

Realized Logical 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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
logical_switch_id Id of the logical switch string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedLogicalSwitch string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15
transport_zone_id Transport zone identifier string Readonly

RealizedMACSet (schema) (Experimental)

Realized MACSet

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedMACSet string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedMACSetListRequestParameters (schema) (Experimental)

Realized 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 to result of query 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

RealizedMACSetListResult (schema) (Experimental)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 Realized MACSets array of RealizedMACSet
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedNSGroup (schema) (Experimental)

Realized Network and Security Group

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
evaluations Evaluated members of NSGroup

Reference to the evaluated members of the NSGroup.
array of RealizedNSGroupMemberEvaluation Readonly
Maximum items: 500
id Unique identifier of this resource string Readonly
Sortable
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedNSGroup string Required
Enum: RealizedNSGroup, RealizedSecurityGroup
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedNSGroupListRequestParameters (schema) (Experimental)

Realized 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 to result of query 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

RealizedNSGroupListResult (schema) (Experimental)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 realized NSGroups array of RealizedNSGroup Readonly
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedNSGroupMemberEvaluation (schema) (Experimental)

Realized NSGroup member evaluation

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
logical_ports list of logical ports array of RealizedLogicalPort Readonly
logical_switches list of logical switches array of RealizedLogicalSwitch Readonly
member_count Count of the members added to this NSGroup integer Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedNSGroupMemberEvaluation string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15
virtual_machines list of virtual machines array of RealizedVirtualMachine Readonly

RealizedNSService (schema) (Experimental)

Realized NSService

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedNSService string Required
Enum: RealizedNSService
service_type Realized nsservice type string Readonly
Enum: SERVICE, SERVICE_GROUP
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedNSServiceListRequestParameters (schema) (Experimental)

Realized 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
included_fields Comma separated list of fields that should be included to result of query 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

RealizedNSServiceListResult (schema) (Experimental)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 realized services array of RealizedNSService Readonly
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedSecurityGroup (schema) (Experimental)

Realized Network and Security Group

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
evaluations Evaluated members of Security Group

Reference to the evaluted members of the Security Group.
array of RealizedSecurityGroupMemberEvaluation Readonly
Maximum items: 500
id Unique identifier of this resource string Readonly
Sortable
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedSecurityGroup string Required
Enum: RealizedNSGroup, RealizedSecurityGroup
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedSecurityGroupListRequestParameters (schema) (Experimental)

Realized Security Group 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 to result of query 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

RealizedSecurityGroupListResult (schema) (Experimental)

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 realized Security Groups array of RealizedSecurityGroup Readonly
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

RealizedSecurityGroupMemberEvaluation (schema) (Experimental)

Realized Security Group member evaluation

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
member_count Count of the members added to this Security Group integer Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedSecurityGroupMemberEvaluation string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15
virtual_machines list of virtual machines array of RealizedVirtualMachine Readonly

RealizedService (schema) (Experimental)

Realized 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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedService string Required
Enum: RealizedNSService
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedServices (schema) (Experimental)

Realized 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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
realized_services List of realized services array of RealizedService
(Abstract type: pass one of the following concrete types)
RealizedNSService
RealizedService
Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedServices string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedState (schema) (Experimental)

Root of realized policy state

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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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
enforcement_points Enforcement points for realized policy array of RealizedEnforcementPoint
id Unique identifier of this resource string Readonly
Sortable
intent_reference Desire state paths of this object array of string
path Absolute path of this object

Absolute path of this object
string Readonly
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedState string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

RealizedVirtualMachine (schema) (Experimental)

Realized 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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
alarms Alarm info detail array of PolicyAlarmResource
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 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_id Id of the host on which the vm exists. string Readonly
id Unique identifier of this resource string Readonly
Sortable
intent_reference Desire state paths of this object array of string
local_id_on_host Id of the vm unique within the host. string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
power_state Current power state of this virtual machine in the system. string Readonly
Enum: VM_RUNNING, VM_STOPPED, VM_SUSPENDED, UNKNOWN
realization_specific_identifier Realization id of this object string
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value RealizedVirtualMachine string
state Realization state of this object string Required
Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

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

RemoteFilestoreBackupFile (schema)

Remote file store backup file properties

Name Description Type Notes
file_store File location string Required
Enum: remote
passphrase Passphrase used to encrypt backup file string Required
port Server port integer Minimum: 1
Maximum: 65535
protocol Protocol to use to copy file ScpProtocol or SftpProtocol Required
server Remote server hostname or IP address string Required
Pattern: "^[^/:]+$"
uri URI of file to copy string Required

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 to result of query 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

Resource (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 string Readonly
_self SelfResourceLink Readonly

ResourceLink (schema)

Name Description Type Notes
action Optional action string Readonly
href 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

RestoreProperties (schema)

Restore properties

Name Description Type Notes
restore_file Restore file LocalFilestoreBackupFile or RemoteFilestoreBackupFile Required

RestoreStep (schema)

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)

Name Description Type Notes
_links 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.
integer Readonly
_schema string Readonly
_self SelfResourceLink Readonly

ScpProtocol (schema)

Name Description Type Notes
authentication_scheme Scheme to authenticate if required PasswordAuthenticationScheme Required
name Protocol name string Required
Enum: scp
ssh_fingerprint SSH fingerprint of server string Required

SecurityCertificate (schema)

Name Description Type Notes
pem_encoded PEM encoded X.509 certificate

The certificate must include the enclosing "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----"
string Required
Minimum length: 52
ssh_public_key string Readonly
text X.509 certificate in text form string Readonly
Minimum length: 52
valid_from The time when the certificate starts being valid string Readonly
valid_to The time when the certificate stops being valid string Readonly

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 string Required
Readonly
rel Link relation type

Custom relation type (follows RFC 5988 where appropriate definitions exist)
string Required
Readonly

Service (schema) (Experimental)

Contains the information related to a service

Used while defining a CommunicationProfileEntry. A service may have multiple
service entries.

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Service string
service_entries Service type array of ServiceEntry
(Abstract type: pass one of the following concrete types)
ALGTypeServiceEntry
EtherTypeServiceEntry
ICMPTypeServiceEntry
IGMPTypeServiceEntry
IPProtocolServiceEntry
L4PortSetServiceEntry
Required
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

ServiceEntry (schema) (Experimental)

An Service entry that describes traffic

This is an abstract type. Concrete child types:
ALGTypeServiceEntry
EtherTypeServiceEntry
ICMPTypeServiceEntry
IGMPTypeServiceEntry
IPProtocolServiceEntry
L4PortSetServiceEntry

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.
integer Readonly
_schema string Readonly
_self 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
path Absolute path of this object

Absolute path of this object
string Readonly
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value ServiceEntry string Required
Enum: EtherTypeServiceEntry, IPProtocolServiceEntry, IGMPTypeServiceEntry, ICMPTypeServiceEntry, ALGTypeServiceEntry, L4PortSetServiceEntry
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 15

ServiceEntryListRequestParameters (schema) (Experimental)

Service entry 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 to result of query 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

ServiceEntryListResult (schema) (Experimental)

Paged Collection of Service entries

Name Description Type Notes
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_schema string Readonly
_self 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 entry list results array of ServiceEntry
(Abstract type: pass one of the following concrete types)
ALGTypeServiceEntry
EtherTypeServiceEntry
ICMPTypeServiceEntry
IGMPTypeServiceEntry
IPProtocolServiceEntry
L4PortSetServiceEntry
Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

ServiceListRequestParameters (schema) (Experimental)

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 to result of query 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

ServiceListResult (schema) (Experimental)

Paged Collection of 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 string Readonly
_self 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 results array of Service Required
sort_ascending boolean Readonly
sort_by Field by which records are sorted string Readonly

SftpProtocol (schema)

Name Description Type Notes
authentication_scheme Scheme to authenticate if required PasswordAuthenticationScheme Required
name Protocol name string Required
Enum: sftp
ssh_fingerprint SSH fingerprint of server string Required

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

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 string Readonly
_self 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 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

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"

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

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)

Name Description Type Notes
scope Tag scope

Tag searches may optionally be restricted by scope
string Maximum length: 20
Default: ""
tag Tag value

Identifier meaningful to user
string Maximum length: 40
Default: ""

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 string Readonly
_self 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

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

TimeDuration (schema)

Time duration in milliseconds

Name Description Type Notes
TimeDuration Time duration in milliseconds integer

Timezone (schema)

Timezone of system

Name Description Type Notes
tzname Standard abbreviation of timezone string Maximum length: 40

UnboundedKeyValuePair (schema)

Name Description Type Notes
key Key string Required
value Value string Required

UpdatePolicyUIPreferencesRequestParams (schema)

Name Description Type Notes
path Specifies the entity for which the UI preferences have to be updated. string Required

UpgradeBundle (schema)

Name Description Type Notes
file Upgrade bundle file multipart_file Required

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 string Readonly
_self 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 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_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

UpgradeTaskProperties (schema)

Task properties

Name Description Type Notes
action_name helper for the task string
bundle_name Name of Bundle string Required
parameters Bundle arguments array of KeyValuePair Readonly

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 string Readonly
_self 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 string Readonly
_self 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 to result of query 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 string Readonly
_self 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 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.
integer Readonly
_schema string Readonly
_self 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: 15
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.
integer Readonly
_schema string Readonly
_self 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: 15
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 string Readonly
_self 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 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 to result of query 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 string Readonly
_self 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 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 string Readonly
_self 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 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 to result of query 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 string Readonly
_self 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 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 string Readonly
_self 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 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 to result of query 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"

UsernamePasswordLoginCredential (schema)

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

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

VlanID (schema)

Name Description Type Notes
VlanID integer Minimum: 0
Maximum: 4094



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", 
  "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, 
      "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, 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }
  }, 
  "title": "An NSService element that represents an ALG protocol", 
  "type": "object"
}

ALGTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ServiceEntry"+
  }, 
  "id": "ALGTypeServiceEntry", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ALGTypeServiceEntry"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alg": {
      "enum": [
        "ORACLE_TNS", 
        "FTP", 
        "SUN_RPC_TCP", 
        "SUN_RPC_UDP", 
        "MS_RPC_TCP", 
        "MS_RPC_UDP", 
        "NBNS_BROADCAST", 
        "NBDG_BROADCAST"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "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"
    }, 
    "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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeServiceEntry", 
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "An ServiceEntry that represents an ALG protocol", 
  "type": "object"
}

AboveRuleIdParameter (type)

{
  "additionalProperties": false, 
  "id": "AboveRuleIdParameter", 
  "properties": {
    "above_rule_id": {
      "description": "Uuid of rule above which this rule is to be inserted", 
      "title": "Uuid of rule above which this rule is to be inserted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AbstractSpace (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents the space in which the policy is being defined", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "AbstractSpace", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "communication_profiles": {
      "description": "This field is used while creating or updating the space.\n", 
      "items": {
        "$ref": "CommunicationProfile"+
      }, 
      "required": false, 
      "title": "CommunicationProfiles under this space", 
      "type": "array"
    }, 
    "connectivity_strategy": {
      "default": "NONE", 
      "description": "This field indicates the default connectivity policy for the infra\nor tenant space\nWHITELIST - Adds a default drop rule. Administrator can then use \"allow\"\nrules (aka whitelist) to allow traffic between groups\nBLACKLIST - Adds a default allow rule. Admin can then use \"drop\" rules\n(aka blacklist) to block traffic between groups\nNONE - No default rules are added. This is the default setting\n", 
      "enum": [
        "WHITELIST", 
        "BLACKLIST", 
        "NONE"
      ], 
      "required": false, 
      "title": "Connectivity strategy used by this tenant", 
      "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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "The space in which policy is being defined", 
  "type": "object"
}

ActionDescriptor (type)

{
  "additionalProperties": false, 
  "id": "ActionDescriptor", 
  "properties": {
    "description": {
      "readonly": true, 
      "title": "A description of what the action does", 
      "type": "string"
    }, 
    "descriptor": {
      "readonly": true, 
      "required": true, 
      "title": "The URI of the REST routine provider that implements the action", 
      "type": "string"
    }, 
    "name": {
      "readonly": true, 
      "required": true, 
      "title": "The name of the action", 
      "type": "string"
    }, 
    "uri": {
      "readonly": true, 
      "required": true, 
      "title": "The URI to use to invoke the action", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ActionParameter (type)

{
  "additionalProperties": false, 
  "id": "ActionParameter", 
  "properties": {
    "action": {
      "enum": [
        "retry", 
        "force-sync"
      ], 
      "title": "Action to be done for the entity configuration.", 
      "type": "string"
    }
  }, 
  "type": "object"
}

AllocationTokenParameter (type)

{
  "additionalProperties": false, 
  "id": "AllocationTokenParameter", 
  "properties": {
    "allocation_token": {
      "description": "Unique pool allocation token to ensure idempotent allocation release.", 
      "maxLength": 64, 
      "type": "string"
    }
  }, 
  "type": "object"
}

ApiError (type)

{
  "id": "ApiError", 
  "properties": {
    "details": {
      "type": "string"
    }, 
    "error_code": {
      "type": "integer"
    }, 
    "error_data": {
      "items": {
        "type": "string"
      }, 
      "type": "array"
    }, 
    "error_message": {
      "type": "string"
    }, 
    "module_name": {
      "type": "string"
    }, 
    "related_errors": {
      "items": {
        "$ref": "ApiError"+
      }, 
      "type": "array"
    }
  }, 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
}

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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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.", 
      "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"
}

BackupFile (type)

{
  "additionalProperties": {}, 
  "id": "BackupFile", 
  "properties": {
    "file_store": {
      "enum": [
        "local", 
        "remote"
      ], 
      "required": true, 
      "title": "File location", 
      "type": "string"
    }, 
    "passphrase": {
      "required": true, 
      "sensitive": true, 
      "title": "Passphrase used to encrypt backup file", 
      "type": "string"
    }
  }, 
  "title": "Backup file properties", 
  "type": "object"
}

BackupProperties (type)

{
  "additionalProperties": false, 
  "id": "BackupProperties", 
  "properties": {
    "backup_file": {
      "required": true, 
      "title": "Backup file", 
      "type": [
        {
          "$ref": "LocalFilestoreBackupFile"+
        }, 
        {
          "$ref": "RemoteFilestoreBackupFile"+
        }
      ]
    }
  }, 
  "title": "Backup properties", 
  "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", 
  "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"
    }
  }, 
  "type": "object"
}

BatchRequest (type)

{
  "id": "BatchRequest", 
  "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"+
      }, 
      "type": "array"
    }
  }, 
  "type": "object"
}

BatchRequestItem (type)

{
  "id": "BatchRequestItem", 
  "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"
    }
  }, 
  "type": "object"
}

BatchResponse (type)

{
  "additionalProperties": false, 
  "id": "BatchResponse", 
  "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"
    }
  }, 
  "type": "object"
}

BatchResponseItem (type)

{
  "id": "BatchResponseItem", 
  "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"
    }
  }, 
  "type": "object"
}

BulkUpdateUpgradeUnitGroupsRequest (type)

{
  "id": "BulkUpdateUpgradeUnitGroupsRequest", 
  "properties": {
    "requests": {
      "items": {
        "$ref": "UpgradeUnitGroup"+
      }, 
      "required": true, 
      "type": "array"
    }
  }, 
  "type": "object"
}

CCPUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus"+
  }, 
  "id": "CCPUpgradeStatus", 
  "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"
}

Certificate (type)

{
  "id": "Certificate", 
  "properties": {
    "pem_encoded": {
      "readonly": true, 
      "required": true, 
      "title": "PEM encoded X.509 certificate", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CertificateId (type)

{
  "additionalProperties": false, 
  "id": "CertificateId", 
  "properties": {
    "certificate_id": {
      "readonly": true, 
      "required": true, 
      "title": "Certificate ID", 
      "type": "string"
    }
  }, 
  "type": "object"
}

CertificateKeyPair (type)

{
  "additionalProperties": false, 
  "id": "CertificateKeyPair", 
  "properties": {
    "certificate": {
      "$ref": "SecurityCertificate"+, 
      "display": {
        "order": 1
      }, 
      "readonly": false, 
      "required": true
    }, 
    "rsa_private_key": {
      "description": "The private key must include the enclosing \"-----BEGIN RSA PRIVATE KEY-----\" and \"-----END RSA PRIVATE KEY-----\". An empty string is returned in read responses.", 
      "display": {
        "order": 2
      }, 
      "minLength": 60, 
      "readonly": false, 
      "required": true, 
      "sensitive": true, 
      "title": "PEM encoded RSA private key", 
      "type": "string"
    }
  }, 
  "type": "object"
}

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"
}

ClusterRestoreStatus (type)

{
  "id": "ClusterRestoreStatus", 
  "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"
    }
  }, 
  "type": "object"
}

CommunicationEntry (type)

{
  "additionalProperties": false, 
  "description": "Binding of source and destination groups to a CommunicationProfile", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "CommunicationEntry", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "communication_profile_path": {
      "description": "Path of the CommunicationProfile participating in this map", 
      "required": false, 
      "title": "Path of the CommunicationProfile participating in this map", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_groups": {
      "description": "We need paths as duplicate names may exist for groups under different\ndomains.In order to specify all groups, use the constant \"ANY\". This\nis case insensitive. If \"ANY\" is used, it should be the ONLY element\nin the group array. Error will be thrown if ANY is used in conjunction\nwith other values.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Destination group paths", 
      "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"
    }, 
    "logged": {
      "default": false, 
      "description": "Flag to enable packet logging. Default is disabled.", 
      "readonly": false, 
      "required": false, 
      "title": "Enable logging flag", 
      "type": "boolean"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple\nCommunicationEntries under CommunicationMap for a Domain\n", 
      "required": false, 
      "title": "Sequence number of the this CommunicationEntry", 
      "type": "int"
    }, 
    "source_groups": {
      "description": "We need paths as duplicate names may exist for groups under different\ndomains. In order to specify all groups, use the constant \"ANY\". This\nis case insensitive. If \"ANY\" is used, it should be the ONLY element\nin the group array. Error will be thrown if ANY is used in conjunction\nwith other values.\n", 
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Source group paths", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Binding of source and destination groups to a CommunicationProfile", 
  "type": "object"
}

CommunicationEntryListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "CommunicationEntryListRequestParameters", 
  "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 to result of query", 
      "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": "CommunicationEntry list request parameters", 
  "type": "object"
}

CommunicationEntryListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "CommunicationEntryListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "CommunicationEntry"+
      }, 
      "required": true, 
      "title": "CommunicationEntry list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of CommunicationEntries", 
  "type": "object"
}

CommunicationMap (type)

{
  "additionalProperties": false, 
  "description": "Ordered list of CommunicationEntries. This object is created by default\nalong with the Domain.\n", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "CommunicationMap", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "communication_entries": {
      "items": {
        "$ref": "CommunicationEntry"+
      }, 
      "required": false, 
      "title": "CommunicationEntries that are a part of this CommunicationMap", 
      "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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "precedence": {
      "description": "This field is used to resolve conflicts between communication maps\nacross domains. In order to change the precedence of a communication\nmap, it is recommended to send a POST request to the following URL\n/infra/domains/<domain-id>/communication-map?action=revise\nThe precedence field will reflect the value of the computed precedence\nupon execution of the above mentioned POST request.\nFor scenarios where the administrator is using a template to update\nseveral communication maps, the only way to set the precedence is to\nexplicitly specify the precedence number for each communication map.\n", 
      "required": false, 
      "title": "Precedence to resolve conflicts across Domains", 
      "type": "int"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Contains ordered list of CommunicationEntries", 
  "type": "object"
}

CommunicationMapInsertParameters (type)

{
  "experimental": true, 
  "id": "CommunicationMapInsertParameters", 
  "properties": {
    "anchor_path": {
      "required": false, 
      "title": "The communication map path if operation is 'insert_after'\nor insert_before\n", 
      "type": "string"
    }, 
    "operation": {
      "default": "insert_top", 
      "enum": [
        "insert_top", 
        "insert_bottom", 
        "insert_after", 
        "insert_before"
      ], 
      "required": false, 
      "title": "Operation", 
      "type": "string"
    }
  }, 
  "title": "Parameters to tell where communication map needs to be placed", 
  "type": "object"
}

CommunicationProfile (type)

{
  "additionalProperties": false, 
  "description": "List of CommunicationProfileEntries", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "CommunicationProfile", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "communication_profile_entries": {
      "items": {
        "$ref": "CommunicationProfileEntry"+
      }, 
      "required": true, 
      "title": "CommunicationProfileEntries that are a part of this CommunicationProfile", 
      "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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Contains ordered list of CommunicationProfileEntries", 
  "type": "object"
}

CommunicationProfileEntry (type)

{
  "additionalProperties": false, 
  "description": "Specifies the service along with the action", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "CommunicationProfileEntry", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "This action will apply on the all the services specified in the\nabove array.\n", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT"
      ], 
      "required": true, 
      "title": "Action", 
      "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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "sequence_number": {
      "description": "This field is used to resolve conflicts between multiple\nCommunicationProfileEntries under CommunicationProfile for a Domain.\nThis will be used to resolve conflicts when there are multiple\nCommunicationProfileEntries under a CommunicationProfile that refer\nto the same Service, but have conflicting.\n", 
      "required": false, 
      "title": "Sequence number of the this CommunicationProfileEntry", 
      "type": "int"
    }, 
    "services": {
      "description": "In order to specify all services, use the constant \"ANY\".\nThis is case insensitive. If \"ANY\" is used, it should\nbe the ONLY element in the services array. Error will be thrown\nif ANY is used in conjunction with other values.\n", 
      "items": {
        "type": "string"
      }, 
      "required": true, 
      "title": "Names of services that forms this CommunicationProfileEntry", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Specifies the service along with the action", 
  "type": "object"
}

CommunicationProfileEntryListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "CommunicationProfileEntryListRequestParameters", 
  "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 to result of query", 
      "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": "CommunicationProfileEntry list request parameters", 
  "type": "object"
}

CommunicationProfileEntryListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "CommunicationProfileEntryListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "CommunicationProfileEntry"+
      }, 
      "required": true, 
      "title": "CommunicationProfileEntry list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of CommunicationProfileEntries", 
  "type": "object"
}

CommunicationProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "CommunicationProfileListRequestParameters", 
  "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 to result of query", 
      "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": "CommunicationProfile list request parameters", 
  "type": "object"
}

CommunicationProfileListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "CommunicationProfileListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "CommunicationProfile"+
      }, 
      "required": true, 
      "title": "CommunicationProfile list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of CommunicationProfiles", 
  "type": "object"
}

ComponentTargetVersion (type)

{
  "id": "ComponentTargetVersion", 
  "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", 
  "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 to result of query", 
      "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", 
  "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"
}

Condition (type)

{
  "additionalProperties": false, 
  "description": "Represents the leaf level condition", 
  "experimental": true, 
  "extends": {
    "$ref": "Expression"+
  }, 
  "id": "Condition", 
  "polymorphic-type-descriptor": {
    "type-identifier": "Condition"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": {
      "enum": [
        "Tag", 
        "Name"
      ], 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "member_type": {
      "enum": [
        "VirtualMachine", 
        "LogicalPort"
      ], 
      "required": true, 
      "title": "Group member type", 
      "type": "string"
    }, 
    "operator": {
      "enum": [
        "EQUALS", 
        "CONTAINS", 
        "STARTSWITH"
      ], 
      "required": true, 
      "title": "operator", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "value": {
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "title": "Represents the leaf level condition", 
  "type": "object"
}

ConfigurationState (type)

{
  "id": "ConfigurationState", 
  "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"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ConfigurationStateElement (type)

{
  "id": "ConfigurationStateElement", 
  "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"
    }
  }, 
  "type": "object"
}

ConjunctionOperator (type)

{
  "additionalProperties": false, 
  "description": "Represents the operators AND or OR", 
  "experimental": true, 
  "extends": {
    "$ref": "Expression"+
  }, 
  "id": "ConjunctionOperator", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ConjunctionOperator"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "conjunction_operator": {
      "enum": [
        "OR", 
        "AND"
      ], 
      "required": true, 
      "title": "Conjunction Operator Node", 
      "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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents the operators AND or OR", 
  "type": "object"
}

ContentFilterValue (type)

{
  "enum": [
    "ALL", 
    "DEFAULT"
  ], 
  "id": "ContentFilterValue", 
  "title": "Support bundle content filter allowed values", 
  "type": "string"
}

ContinueRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "ContinueRequestParameters", 
  "properties": {
    "skip": {
      "default": false, 
      "readonly": false, 
      "required": false, 
      "title": "Skip to upgrade of next component.", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

CopyFromRemoteFileProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties"+
  }, 
  "id": "CopyFromRemoteFileProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "required": true, 
      "title": "Protocol to use to copy file", 
      "type": [
        {
          "$ref": "HttpProtocol"+
        }, 
        {
          "$ref": "HttpsProtocol"+
        }, 
        {
          "$ref": "ScpProtocol"+
        }, 
        {
          "$ref": "SftpProtocol"+
        }
      ]
    }, 
    "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": {
      "required": true, 
      "title": "Protocol to use to copy file", 
      "type": [
        {
          "$ref": "ScpProtocol"+
        }, 
        {
          "$ref": "SftpProtocol"+
        }
      ]
    }, 
    "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"
}

CreateRemoteDirectoryProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CopyRemoteFileProperties"+
  }, 
  "id": "CreateRemoteDirectoryProperties", 
  "properties": {
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "required": true, 
      "title": "Protocol to use to copy file", 
      "type": [
        {
          "$ref": "SftpProtocol"+
        }
      ]
    }, 
    "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"
}

CsvListResult (type)

{
  "abstract": true, 
  "description": "Base type for CSV result.", 
  "id": "CsvListResult", 
  "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", 
  "type": "object"
}

DataSourceParameters (type)

{
  "id": "DataSourceParameters", 
  "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", 
  "title": "Data source type.", 
  "type": "string"
}

DefaultRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Default request parameters.", 
  "id": "DefaultRequestParameters", 
  "properties": {
    "include_system_owned": {
      "description": "Flag indicating that operation should be performed on system resources too", 
      "readonly": true, 
      "title": "Perform on system resources", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

DeleteRequestParameters (type)

{
  "additionalProperties": {}, 
  "id": "DeleteRequestParameters", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being\nreferred as a resource reference.\n", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }
  }, 
  "type": "object"
}

DeploymentTypeListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DeploymentTypeListRequestParameters", 
  "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 to result of query", 
      "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"
}

DeploymentZone (type)

{
  "description": "Logical grouping of enforcement points", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "DeploymentZone", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "enforcement_points": {
      "items": {
        "$ref": "EnforcementPoint"+
      }, 
      "required": false, 
      "title": "Logical grouping of enforcement points", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Deployment zone", 
  "type": "object"
}

DeploymentZoneListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "DeploymentZone list request parameters", 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DeploymentZoneListRequestParameters", 
  "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 to result of query", 
      "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": "DeploymentZone list request parameters", 
  "type": "object"
}

DeploymentZoneListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of Deployment Zones", 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DeploymentZoneListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "DeploymentZone"+
      }, 
      "required": true, 
      "title": "Deployment Zones", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Deployment Zones", 
  "type": "object"
}

DiscoveredResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "DiscoveredResource", 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "type": "object"
}

Domain (type)

{
  "additionalProperties": false, 
  "description": "Domain", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "Domain", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "communication_map": {
      "$ref": "CommunicationMap"+, 
      "description": "This field is used while creating or updating the CommunicationMap.\n", 
      "required": false, 
      "title": "CommunicationMap for this Domain"
    }, 
    "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"
    }, 
    "groups": {
      "description": "This field is used while creating or updating the Domain.\nPlease take a look at the UpdateTenant API documentation for details.\n", 
      "items": {
        "$ref": "Group"+
      }, 
      "required": false, 
      "title": "Groups under this Domain", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Domain", 
  "type": "object"
}

DomainDeploymentMap (type)

{
  "description": "Binding of domains to the enforcement point.", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "DomainDeploymentMap", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "enforcement_point_path": {
      "description": "Path of enforcement point on which domain will be deployed", 
      "required": true, 
      "title": "Absolute path of enforcement point", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Domain deployment map", 
  "type": "object"
}

DomainDeploymentMapListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "DomainDeploymentMap list request parameters", 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DomainDeploymentMapListRequestParameters", 
  "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 to result of query", 
      "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": "DomainDeploymentMap list request parameters", 
  "type": "object"
}

DomainDeploymentMapListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged Collection of Domain Deployment map", 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DomainDeploymentMapListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "DomainDeploymentMap"+
      }, 
      "required": true, 
      "title": "Domain Deployment Map", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Domain Deployment map", 
  "type": "object"
}

DomainListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "DomainListRequestParameters", 
  "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 to result of query", 
      "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": "Domain list request parameters", 
  "type": "object"
}

DomainListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "DomainListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "Domain"+
      }, 
      "required": true, 
      "title": "Domain list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Domains", 
  "type": "object"
}

EdgeClusterNodeType (type)

{
  "enum": [
    "EDGE_NODE", 
    "PUBLIC_CLOUD_GATEWAY_NODE", 
    "UNKNOWN"
  ], 
  "id": "EdgeClusterNodeType", 
  "title": "Supported edge cluster node type.", 
  "type": "string"
}

EdgeDeploymentType (type)

{
  "enum": [
    "VIRTUAL_MACHINE", 
    "PHYSICAL_MACHINE", 
    "UNKNOWN"
  ], 
  "id": "EdgeDeploymentType", 
  "title": "Supported edge deployment type.", 
  "type": "string"
}

EdgeFormFactor (type)

{
  "enum": [
    "SMALL", 
    "MEDIUM", 
    "LARGE"
  ], 
  "id": "EdgeFormFactor", 
  "title": "Supported edge form factor.", 
  "type": "string"
}

EdgeUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus"+
  }, 
  "id": "EdgeUpgradeStatus", 
  "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"
}

EmbeddedResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "EmbeddedResource", 
  "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
    }, 
    "_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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
    }
  }, 
  "type": "object"
}

EnforcementPoint (type)

{
  "description": "Represents endpoint where policy will be applied", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "EnforcementPoint", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "connection_info": {
      "$ref": "EnforcementPointConnectionInfo"+, 
      "required": true, 
      "title": "Enforcement point connection info"
    }, 
    "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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "version": {
      "readonly": true, 
      "title": "Version of the Enforcement point", 
      "type": "string"
    }
  }, 
  "title": "Represents endpoint where policy will be applied", 
  "type": "object"
}

EnforcementPointConnectionInfo (type)

{
  "abstract": true, 
  "description": "Contains information required to connect to enforcement point", 
  "experimental": true, 
  "id": "EnforcementPointConnectionInfo", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "enforcement_point_address": {
      "format": "hostname_or_ip", 
      "required": false, 
      "title": "Address of the Enforcement point", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "Enforcement point connection info", 
  "type": "object"
}

EnforcementPointListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "EnforcementPoint list request parameters", 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "EnforcementPointListRequestParameters", 
  "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 to result of query", 
      "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": "EnforcementPoint list request parameters", 
  "type": "object"
}

EnforcementPointListResult (type)

{
  "additionalProperties": false, 
  "description": "Paged collection of enforcement points", 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "EnforcementPointListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "EnforcementPoint"+
      }, 
      "required": true, 
      "title": "EnforcementPoint list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of EnforcementPoints", 
  "type": "object"
}

EpochMsTimestamp (type)

{
  "id": "EpochMsTimestamp", 
  "title": "Timestamp in milliseconds since epoch", 
  "type": "integer"
}

EtherTypeNSService (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "EtherTypeNSService", 
  "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, 
      "type": "string"
    }
  }, 
  "title": "An NSService element that represents an ethertype protocol", 
  "type": "object"
}

EtherTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ServiceEntry"+
  }, 
  "id": "EtherTypeServiceEntry", 
  "polymorphic-type-descriptor": {
    "type-identifier": "EtherTypeServiceEntry"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "ether_type": {
      "required": true, 
      "title": "Type of the encapsulated protocol", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeServiceEntry", 
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "A ServiceEntry that represents an ethertype protocol", 
  "type": "object"
}

Expression (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "All the nodes of the expression extend from this abstract class. This\nis present for extensibility.\n", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "Expression", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Base class for each node of the expression", 
  "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"
}

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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "File properties query results", 
  "type": "object"
}

FileRequestHeaders (type)

{
  "additionalProperties": {}, 
  "description": "Header definition for requests to transfer files.", 
  "id": "FileRequestHeaders", 
  "properties": {
    "Range": {
      "readonly": true, 
      "type": "string"
    }
  }, 
  "title": "File request headers", 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
}

GlobalRestoreStatus (type)

{
  "id": "GlobalRestoreStatus", 
  "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"
    }
  }, 
  "type": "object"
}

Group (type)

{
  "additionalProperties": false, 
  "description": "Group", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "Group", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "expression": {
      "description": "Expression", 
      "items": {
        "$ref": "Expression"+
      }, 
      "required": false, 
      "title": "Expression", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "IN_PROGRESS", 
        "SUCCESS", 
        "FAILURE"
      ], 
      "required": false, 
      "title": "Realization state of this group", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Group", 
  "type": "object"
}

GroupDeleteRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "DeleteRequestParameters"+
  }, 
  "id": "GroupDeleteRequestParameters", 
  "properties": {
    "force": {
      "default": false, 
      "description": "If true, deleting the resource succeeds even if it is being\nreferred as a resource reference.\n", 
      "title": "Force delete the resource even if it is being used somewhere\n", 
      "type": "boolean"
    }
  }, 
  "title": "Group delete request parameters", 
  "type": "object"
}

GroupListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "GroupListRequestParameters", 
  "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 to result of query", 
      "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": "Group list request parameters", 
  "type": "object"
}

GroupListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "GroupListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "Group"+
      }, 
      "required": true, 
      "title": "Group list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Groups", 
  "type": "object"
}

GroupStatusListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "GroupStatusListRequestParameters", 
  "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 to result of query", 
      "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"
}

HostUpgradeStatus (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ComponentUpgradeStatus"+
  }, 
  "id": "HostUpgradeStatus", 
  "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)

{
  "id": "HostnameOrIPv4Address", 
  "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"
}

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", 
  "properties": {
    "authentication_scheme": {
      "title": "Scheme to authenticate if required", 
      "type": [
        {
          "$ref": "BasicAuthenticationScheme"+
        }
      ]
    }, 
    "name": {
      "enum": [
        "http"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }
  }, 
  "type": "object"
}

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"
    }, 
    "connection_timeout": {
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX connection timeout, set to 0 to configure no timeout", 
      "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", 
  "properties": {
    "authentication_scheme": {
      "title": "Scheme to authenticate if required", 
      "type": [
        {
          "$ref": "BasicAuthenticationScheme"+
        }
      ]
    }, 
    "name": {
      "enum": [
        "https"
      ], 
      "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", 
  "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, 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A NSService that represents IPv4 or IPv6 ICMP protocol", 
  "type": "object"
}

ICMPTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ServiceEntry"+
  }, 
  "id": "ICMPTypeServiceEntry", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ICMPTypeServiceEntry"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "icmp_code": {
      "required": false, 
      "title": "ICMP message code", 
      "type": "integer"
    }, 
    "icmp_type": {
      "required": false, 
      "title": "ICMP message type", 
      "type": "integer"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "protocol": {
      "enum": [
        "ICMPv4", 
        "ICMPv6"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeServiceEntry", 
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "A ServiceEntry that represents IPv4 or IPv6 ICMP protocol", 
  "type": "object"
}

IGMPTypeNSService (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "IGMPTypeNSService", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IGMPTypeNSService"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "A NSService that represents IGMP protocol", 
  "type": "object"
}

IGMPTypeServiceEntry (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ServiceEntry"+
  }, 
  "id": "IGMPTypeServiceEntry", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IGMPTypeServiceEntry"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeServiceEntry", 
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "A ServiceEntry that represents IGMP protocol", 
  "type": "object"
}

IPAddress (type)

{
  "format": "ip", 
  "id": "IPAddress", 
  "title": "IPv4 or IPv6 address", 
  "type": "string"
}

IPAddressExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents IP address expressions in the form of an array, to support addition of IP addresses in a group.", 
  "experimental": true, 
  "extends": {
    "$ref": "Expression"+
  }, 
  "id": "IPAddressExpression", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IPAddressExpression"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": {
      "description": "This array can consist of a single IP address, IP address range or a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and IPv6 addresses within one expression is not allowed. 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.", 
      "items": {
        "$ref": "IPElement"+
      }, 
      "required": true, 
      "title": "Array of IP addresses", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IP address expression node", 
  "type": "array"
}

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,\n192.168.1.1-192.168.1.100, 192.168.0.0/24,\nfe80::250:56ff:fe83:318c,\nfe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c,\nfe80::250:56ff:fe83:318c/64\n", 
  "format": "address-or-block-or-range", 
  "id": "IPElement", 
  "title": "IP address, range, or subnet", 
  "type": "string"
}

IPProtocolNSService (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "NSServiceElement"+
  }, 
  "id": "IPProtocolNSService", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IPProtocolNSService"
  }, 
  "properties": {
    "protocol_number": {
      "required": true, 
      "type": "integer"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "An NSService element that represents an IP protocol", 
  "type": "object"
}

IPProtocolServiceEntry (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ServiceEntry"+
  }, 
  "id": "IPProtocolServiceEntry", 
  "polymorphic-type-descriptor": {
    "type-identifier": "IPProtocolServiceEntry"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "protocol_number": {
      "required": true, 
      "type": "integer"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeServiceEntry", 
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "A ServiceEntry that represents an IP protocol", 
  "type": "object"
}

IPv4Address (type)

{
  "format": "ipv4", 
  "id": "IPv4Address", 
  "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", 
  "title": "IPv4 CIDR Block", 
  "type": "string"
}

IPv6Address (type)

{
  "format": "ipv6", 
  "id": "IPv6Address", 
  "title": "IPv6 address", 
  "type": "string"
}

IncludedFieldsParameters (type)

{
  "additionalProperties": false, 
  "id": "IncludedFieldsParameters", 
  "properties": {
    "included_fields": {
      "title": "Comma separated list of fields that should be included to result of query", 
      "type": "string"
    }
  }, 
  "type": "object"
}

Infra (type)

{
  "additionalProperties": false, 
  "description": "Infra space related policy", 
  "experimental": true, 
  "extends": {
    "$ref": "AbstractSpace"+
  }, 
  "id": "Infra", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "communication_profiles": {
      "description": "This field is used while creating or updating the space.\n", 
      "items": {
        "$ref": "CommunicationProfile"+
      }, 
      "required": false, 
      "title": "CommunicationProfiles under this space", 
      "type": "array"
    }, 
    "connectivity_strategy": {
      "default": "NONE", 
      "description": "This field indicates the default connectivity policy for the infra\nor tenant space\nWHITELIST - Adds a default drop rule. Administrator can then use \"allow\"\nrules (aka whitelist) to allow traffic between groups\nBLACKLIST - Adds a default allow rule. Admin can then use \"drop\" rules\n(aka blacklist) to block traffic between groups\nNONE - No default rules are added. This is the default setting\n", 
      "enum": [
        "WHITELIST", 
        "BLACKLIST", 
        "NONE"
      ], 
      "required": false, 
      "title": "Connectivity strategy used by this tenant", 
      "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"
    }, 
    "domains": {
      "description": "This field is used while creating or updating the infra space.\n", 
      "items": {
        "$ref": "Domain"+
      }, 
      "required": false, 
      "title": "Domains for infra", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Infra", 
  "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"
}

InstructionInfo (type)

{
  "id": "InstructionInfo", 
  "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"
    }
  }, 
  "type": "object"
}

InterfaceStatistics (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "InterfaceStatistics", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
    }
  }, 
  "type": "object"
}

KeyValuePair (type)

{
  "additionalProperties": false, 
  "id": "KeyValuePair", 
  "properties": {
    "key": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "value": {
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "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"
}

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", 
  "polymorphic-type-descriptor": {
    "type-identifier": "L4PortSetNSService"
  }, 
  "properties": {
    "destination_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }, 
    "l4_protocol": {
      "enum": [
        "TCP", 
        "UDP"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }
  }, 
  "title": "An NSService element that represents TCP or UDP protocol", 
  "type": "object"
}

L4PortSetServiceEntry (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", 
  "experimental": true, 
  "extends": {
    "$ref": "ServiceEntry"+
  }, 
  "id": "L4PortSetServiceEntry", 
  "polymorphic-type-descriptor": {
    "type-identifier": "L4PortSetServiceEntry"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "destination_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": true, 
      "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"
    }, 
    "l4_protocol": {
      "enum": [
        "TCP", 
        "UDP"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeServiceEntry", 
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "source_ports": {
      "items": {
        "$ref": "PortElement"+
      }, 
      "maxItems": 15, 
      "required": false, 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "An ServiceEntry that represents TCP or UDP protocol", 
  "type": "object"
}

ListRequestParameters (type)

{
  "additionalProperties": {}, 
  "extends": {
    "$ref": "IncludedFieldsParameters"+
  }, 
  "id": "ListRequestParameters", 
  "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 to result of query", 
      "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListResultQueryParameters (type)

{
  "id": "ListResultQueryParameters", 
  "properties": {
    "fields": {
      "description": "Comma-separated field names to include in query result", 
      "title": "Fields to include in query results", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ListWithDataSourceParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ListWithDataSourceParameters", 
  "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 to result of query", 
      "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"
}

LocalFilestoreBackupFile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BackupFile"+
  }, 
  "id": "LocalFilestoreBackupFile", 
  "properties": {
    "file_store": {
      "enum": [
        "local"
      ], 
      "required": true, 
      "title": "File location", 
      "type": "string"
    }, 
    "name": {
      "pattern": "^[^/]+$", 
      "required": false, 
      "title": "File name", 
      "type": "string"
    }, 
    "passphrase": {
      "required": true, 
      "sensitive": true, 
      "title": "Passphrase used to encrypt backup file", 
      "type": "string"
    }
  }, 
  "title": "Local file store backup file", 
  "type": "object"
}

LoggingServiceProperties (type)

{
  "additionalProperties": false, 
  "id": "LoggingServiceProperties", 
  "properties": {
    "logging_level": {
      "enum": [
        "ERROR", 
        "WARN", 
        "INFO", 
        "DEBUG", 
        "TRACE"
      ], 
      "required": true, 
      "title": "Service logging level", 
      "type": "string"
    }, 
    "package_logging_level": {
      "items": {
        "$ref": "PackageLoggingLevels"+
      }, 
      "title": "Package logging levels", 
      "type": "array"
    }
  }, 
  "title": "Service properties", 
  "type": "object"
}

LoginCredential (type)

{
  "id": "LoginCredential", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "credential_type"
  }, 
  "properties": {
    "credential_type": {
      "help_summary": "Possible values are 'UsernamePasswordLoginCredential', 'VerifiableAsymmetricLoginCredential'.", 
      "required": true, 
      "title": "Login credential, for example username-password-thumbprint or certificate based, etc", 
      "type": "string"
    }
  }, 
  "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", 
  "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"
}

MACAddressExpression (type)

{
  "additionalProperties": false, 
  "description": "Represents MAC address expressions in the form of an array, to support addition of MAC addresses in a group.", 
  "experimental": true, 
  "extends": {
    "$ref": "Expression"+
  }, 
  "id": "MACAddressExpression", 
  "polymorphic-type-descriptor": {
    "type-identifier": "MACAddressExpression"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": {
      "description": "This array can consist of one or more MAC addresses.", 
      "items": {
        "$ref": "MACAddress"+
      }, 
      "required": true, 
      "title": "Array of MAC addresses", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "MAC address expression node", 
  "type": "array"
}

ManagedResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "RevisionedResource"+
  }, 
  "id": "ManagedResource", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
}

MsgClientInfo (type)

{
  "id": "MsgClientInfo", 
  "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"
    }
  }, 
  "type": "object"
}

NSServiceElement (type)

{
  "abstract": true, 
  "id": "NSServiceElement", 
  "polymorphic-type-descriptor": {
    "mode": "enabled", 
    "property-name": "resource_type"
  }, 
  "properties": {
    "resource_type": {
      "enum": [
        "EtherTypeNSService", 
        "IPProtocolNSService", 
        "IGMPTypeNSService", 
        "ICMPTypeNSService", 
        "ALGTypeNSService", 
        "L4PortSetNSService"
      ], 
      "required": true, 
      "type": "string"
    }
  }, 
  "title": "An NSService element that describes traffic corresponding to an NSService", 
  "type": "object"
}

NSXTConnectionInfo (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "EnforcementPointConnectionInfo"+
  }, 
  "id": "NSXTConnectionInfo", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NSXTConnectionInfo"
  }, 
  "properties": {
    "enforcement_point_address": {
      "format": "hostname_or_ip", 
      "required": false, 
      "title": "Address of the Enforcement point", 
      "type": "string"
    }, 
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex.\n", 
      "required": true, 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "username": {
      "required": true, 
      "title": "UserName", 
      "type": "string"
    }
  }, 
  "title": "Credential info to connect to NSXT enforcement type", 
  "type": "object"
}

NSXVConnectionInfo (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "EnforcementPointConnectionInfo"+
  }, 
  "id": "NSXVConnectionInfo", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NSXVConnectionInfo"
  }, 
  "properties": {
    "enforcement_point_address": {
      "format": "hostname_or_ip", 
      "required": false, 
      "title": "Address of the Enforcement point", 
      "type": "string"
    }, 
    "password": {
      "required": true, 
      "sensitive": true, 
      "title": "Password", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "NSXTConnectionInfo", 
        "NSXVConnectionInfo"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "thumbprint": {
      "description": "Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex.\n", 
      "required": true, 
      "title": "Thumbprint of Enforcement Point", 
      "type": "string"
    }, 
    "username": {
      "required": true, 
      "title": "UserName", 
      "type": "string"
    }
  }, 
  "title": "Credential info to connect to NSXV enforcement type", 
  "type": "object"
}

NestedExpression (type)

{
  "additionalProperties": false, 
  "description": "NestedExpression", 
  "experimental": true, 
  "extends": {
    "$ref": "Expression"+
  }, 
  "id": "NestedExpression", 
  "polymorphic-type-descriptor": {
    "type-identifier": "NestedExpression"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "expressions": {
      "description": "Expression", 
      "items": {
        "$ref": "Expression"+
      }, 
      "required": false, 
      "title": "Expression", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "Condition", 
        "ConjunctionOperator", 
        "NestedExpression", 
        "IPAddressExpression", 
        "MACAddressExpression"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "NestedExpression", 
  "type": "object"
}

NoRestRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "Parameter definition for requests that do not allow parameters.", 
  "id": "NoRestRequestParameters", 
  "properties": {}, 
  "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", 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "HttpServiceProperties"+, 
      "title": "HTTP Service properties"
    }
  }, 
  "title": "Node HTTP service properties", 
  "type": "object"
}

NodeInfo (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeInfo", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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", 
  "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 to result of query", 
      "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
}

NodeInterfaceStatisticsProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeInterfaceStatisticsProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "interface_id": {
      "readonly": true, 
      "title": "Interface ID", 
      "type": "string"
    }, 
    "rx_bytes": {
      "readonly": true, 
      "title": "Number of bytes received", 
      "type": "integer"
    }, 
    "rx_dropped": {
      "readonly": true, 
      "title": "Number of packets dropped", 
      "type": "integer"
    }, 
    "rx_errors": {
      "readonly": true, 
      "title": "Number of receive errors", 
      "type": "integer"
    }, 
    "rx_frame": {
      "readonly": true, 
      "title": "Number of framing errors", 
      "type": "integer"
    }, 
    "rx_packets": {
      "readonly": true, 
      "title": "Number of packets received", 
      "type": "integer"
    }, 
    "tx_bytes": {
      "readonly": true, 
      "title": "Number of bytes transmitted", 
      "type": "integer"
    }, 
    "tx_carrier": {
      "readonly": true, 
      "title": "Number of carrier losses detected", 
      "type": "integer"
    }, 
    "tx_colls": {
      "readonly": true, 
      "title": "Number of collisions detected", 
      "type": "integer"
    }, 
    "tx_dropped": {
      "readonly": true, 
      "title": "Number of packets dropped", 
      "type": "integer"
    }, 
    "tx_errors": {
      "readonly": true, 
      "title": "Number of transmit errors", 
      "type": "integer"
    }, 
    "tx_packets": {
      "readonly": true, 
      "title": "Number of packets transmitted", 
      "type": "integer"
    }
  }, 
  "title": "Node network interface statistic properties", 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node log property query results", 
  "type": "object"
}

NodeLogPropertyHeaders (type)

{
  "additionalProperties": {}, 
  "id": "NodeLogPropertyHeaders", 
  "title": "Node log property headers", 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }
  }, 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
    }, 
    "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"
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "service_name": {
      "required": true, 
      "title": "Service name", 
      "type": "string"
    }, 
    "service_properties": {
      "$ref": "SshServiceProperties"+, 
      "title": "SSH Service properties"
    }
  }, 
  "title": "Node SSH service properties", 
  "type": "object"
}

NodeStatusProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "NodeStatusProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
    }, 
    "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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", 
  "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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|security|audit|reqId|ereqId|entId|errorCode)=.+$", 
        "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Node users list results", 
  "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"
}

OwnerResourceLink (type)

{
  "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
  "extends": {
    "$ref": "ResourceLink"+
  }, 
  "id": "OwnerResourceLink", 
  "properties": {
    "action": {
      "readonly": true, 
      "title": "Optional action", 
      "type": "string"
    }, 
    "href": {
      "readonly": true, 
      "required": true, 
      "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"
}

PackageLoggingLevels (type)

{
  "additionalProperties": false, 
  "id": "PackageLoggingLevels", 
  "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"
}

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"
}

PerStepRestoreStatus (type)

{
  "id": "PerStepRestoreStatus", 
  "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"
    }
  }, 
  "type": "object"
}

PolicyAlarmResource (type)

{
  "description": "Alarm base class of realized policy object", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyResource"+
  }, 
  "id": "PolicyAlarmResource", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": {
      "required": false, 
      "title": "error id for the alarm", 
      "type": "string"
    }, 
    "message": {
      "required": false, 
      "title": "error message to describe the issue", 
      "type": "string"
    }, 
    "path": {
      "required": false, 
      "title": "path of the alarm object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Alarm base class of realized policy object", 
  "type": "object"
}

PolicyConfigResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents an object on the desired state", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyResource"+
  }, 
  "id": "PolicyConfigResource", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents an object on the desired state", 
  "type": "object"
}

PolicyNode (type)

{
  "additionalProperties": false, 
  "description": "Representation of a policy node", 
  "id": "PolicyNode", 
  "properties": {
    "attributes": {
      "items": {
        "$ref": "PolicyNodeProperty"+
      }, 
      "required": false, 
      "type": "array"
    }, 
    "children": {
      "description": "None", 
      "items": {
        "$ref": "PolicyNode"+
      }, 
      "required": false, 
      "title": "children of this node", 
      "type": "array"
    }, 
    "id": {
      "required": false, 
      "title": "id of the node", 
      "type": "string"
    }
  }, 
  "title": "PolicyNode", 
  "type": "object"
}

PolicyNodeProperty (type)

{
  "additionalProperties": false, 
  "description": "Representation of a policy node property", 
  "id": "PolicyNodeProperty", 
  "properties": {
    "key": {
      "required": false, 
      "title": "key of the property", 
      "type": "string"
    }, 
    "value": {
      "required": false, 
      "title": "value of the property", 
      "type": "string"
    }
  }, 
  "title": "PolicyNodeProperty", 
  "type": "object"
}

PolicyRealizedResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Abstract base class for all the realized policy objects", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyResource"+
  }, 
  "id": "PolicyRealizedResource", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Abstract base class for all the realized policy objects", 
  "type": "object"
}

PolicyResource (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Abstract base class for all the policy objects", 
  "experimental": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "PolicyResource", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Abstract base class for all the policy objects", 
  "type": "object"
}

PolicyRoot (type)

{
  "abstract": true, 
  "additionalProperties": false, 
  "description": "Represents the root of the policy tree", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "PolicyRoot", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Represents the root of the policy tree", 
  "type": "object"
}

PolicyTemplate (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ManagedResource"+
  }, 
  "id": "PolicyTemplate", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "template_body": {
      "$ref": "AbstractSpace"+, 
      "required": true, 
      "title": "Template Body"
    }, 
    "template_placeholders": {
      "items": {
        "$ref": "PolicyTemplatePlaceholder"+
      }, 
      "required": true, 
      "title": "Template placeholders", 
      "type": "array"
    }
  }, 
  "title": "Policy Template", 
  "type": "object"
}

PolicyTemplateListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "PolicyTemplateListRequestParameters", 
  "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 to result of query", 
      "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": "Policy Template list request parameters", 
  "type": "object"
}

PolicyTemplateListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "PolicyTemplateListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "PolicyTemplate"+
      }, 
      "required": true, 
      "title": "Policy Template list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Policy Templates", 
  "type": "object"
}

PolicyTemplateParameter (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "id": "PolicyTemplateParameter", 
  "properties": {
    "parameter_id": {
      "required": true, 
      "title": "Parameter id", 
      "type": "string"
    }, 
    "parameter_value": {
      "required": true, 
      "title": "Parameter value", 
      "type": "string"
    }
  }, 
  "title": "Policy template parameter", 
  "type": "object"
}

PolicyTemplateParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "id": "PolicyTemplateParameters", 
  "properties": {
    "placeholders": {
      "items": {
        "$ref": "PolicyTemplateParameter"+
      }, 
      "required": true, 
      "title": "List of Policy template parameter", 
      "type": "array"
    }
  }, 
  "title": "Policy template parameters", 
  "type": "object"
}

PolicyTemplatePlaceholder (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "id": "PolicyTemplatePlaceholder", 
  "properties": {
    "placeholder_id": {
      "required": true, 
      "title": "Placeholder id", 
      "type": "string"
    }, 
    "placeholder_message": {
      "required": true, 
      "title": "Placeholder message", 
      "type": "string"
    }
  }, 
  "title": "Policy template placeholdder", 
  "type": "object"
}

PortElement (type)

{
  "description": "Examples- Single port \"8080\", Range of ports \"8090-8095\"\n", 
  "format": "port-or-range", 
  "id": "PortElement", 
  "title": "A port or a port range", 
  "type": "string"
}

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"
}

Protocol (type)

{
  "additionalProperties": {}, 
  "id": "Protocol", 
  "properties": {
    "name": {
      "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"
}

RealizedEnforcementPoint (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedEnforcementPoint", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "realized_firewalls": {
      "$ref": "RealizedFirewalls"+, 
      "readonly": true, 
      "required": false, 
      "title": "Root of Realized Firewalls"
    }, 
    "realized_groups": {
      "$ref": "RealizedGroups"+, 
      "readonly": true, 
      "required": false, 
      "title": "Root of Realized Groups"
    }, 
    "realized_services": {
      "$ref": "RealizedServices"+, 
      "readonly": true, 
      "required": false, 
      "title": "Root of Realized Services"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Enforcement Point", 
  "type": "object"
}

RealizedEnforcementPointListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RealizedEnforcementPointListRequestParameters", 
  "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 to result of query", 
      "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": "Realized enforcement point list request parameters", 
  "type": "object"
}

RealizedEnforcementPointListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedEnforcementPointListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedEnforcementPoint"+, 
        "title": "Enforcement point list result"
      }, 
      "required": false, 
      "title": "Paged Collection of Enforcement Point's", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RealizedFirewall (type)

{
  "abstract": true, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedFirewall", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "RealizedFirewallSection"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized firewall", 
  "type": "object"
}

RealizedFirewallRule (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedFirewallRule", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "action": {
      "description": "Action enforced on the packets which matches the firewall rule.", 
      "enum": [
        "ALLOW", 
        "DROP", 
        "REJECT"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Action", 
      "type": "string"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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": true, 
      "required": false, 
      "title": "Destination List", 
      "type": "array"
    }, 
    "direction": {
      "default": "IN_OUT", 
      "description": "Rule direction in case of stateless firewall 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": true, 
      "required": false, 
      "title": "Rule direction", 
      "type": "string"
    }, 
    "disabled": {
      "description": "Flag to disable rule. Disabled will only be persisted but never provisioned/realized.", 
      "readonly": true, 
      "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": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "services": {
      "description": "List of the services. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": true, 
      "required": false, 
      "title": "Service List", 
      "type": "array"
    }, 
    "sources": {
      "description": "List of sources. Null will be treated as any.", 
      "items": {
        "$ref": "ResourceReference"+
      }, 
      "maxItems": 128, 
      "readonly": true, 
      "required": false, 
      "title": "Source List", 
      "type": "array"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Firewall Rule", 
  "type": "object"
}

RealizedFirewallSection (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "RealizedFirewall"+
  }, 
  "id": "RealizedFirewallSection", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RealizedFirewallSection"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "RealizedFirewallSection"
      ], 
      "required": true, 
      "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.", 
      "items": {
        "$ref": "RealizedFirewallRule"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of the firewall rules", 
      "type": "array"
    }, 
    "section_type": {
      "description": "Type of the rules which a section can contain.", 
      "enum": [
        "LAYER2", 
        "LAYER3"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Section Type", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Firewall section", 
  "type": "object"
}

RealizedFirewallSectionListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RealizedFirewallSectionListRequestParameters", 
  "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 to result of query", 
      "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": "Realized firewall section list request parameters", 
  "type": "object"
}

RealizedFirewallSectionListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedFirewallSectionListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedFirewallSection"+, 
        "title": "Firewall list results"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Paged Collection of firewall sections", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RealizedFirewallUIResource (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "RealizedFirewallUIResource", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "intent_communication_map": {
      "$ref": "CommunicationMap"+
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realized_firewall_sections": {
      "items": {
        "$ref": "RealizedFirewall"+
      }, 
      "required": true, 
      "title": "Realized firewall sections associated to the communication map", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Firewall Sections and associated communication map", 
  "type": "object"
}

RealizedFirewallUIResourceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedFirewallUIResourceListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedFirewallUIResource"+
      }, 
      "required": true, 
      "title": "communication map and realized firewall sections list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of communication map and Realized Firewall Sections Pairs", 
  "type": "object"
}

RealizedFirewalls (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedFirewalls", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "realized_firewalls": {
      "items": {
        "$ref": "RealizedFirewall"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "list of realized firewalls", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized firewalls", 
  "type": "object"
}

RealizedGroup (type)

{
  "abstract": true, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedGroup", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "RealizedNSGroup", 
        "RealizedSecurityGroup"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized group", 
  "type": "object"
}

RealizedGroupUIResource (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "RealizedGroupUIResource", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "intent_group": {
      "$ref": "Group"+
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realized_groups": {
      "items": {
        "$ref": "RealizedGroup"+
      }, 
      "required": true, 
      "title": "Realized groups associated to the intent group", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Groups and associated Intent Group", 
  "type": "object"
}

RealizedGroupUIResourceListResult (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedGroupUIResourceListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedGroupUIResource"+
      }, 
      "required": true, 
      "title": "Intent and realized group list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Intent and Realized Group Pairs", 
  "type": "object"
}

RealizedGroups (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedGroups", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "realized_groups": {
      "items": {
        "$ref": "RealizedGroup"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "list of realized groups", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized groups", 
  "type": "object"
}

RealizedIPSet (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedIPSet", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized IPSet", 
  "type": "object"
}

RealizedIPSetListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RealizedIPSetListRequestParameters", 
  "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 to result of query", 
      "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": "Realized IPSet list request parameters", 
  "type": "object"
}

RealizedIPSetListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedIPSetListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedIPSet"+, 
        "title": "Realized IPSet list result"
      }, 
      "required": false, 
      "title": "Paged Collection of Realized IPSets", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RealizedLogicalPort (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedLogicalPort", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "logical_port_id": {
      "readonly": true, 
      "required": false, 
      "title": "The id of the logical port", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "status": {
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "The Operational status of the logical port", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Logical Port", 
  "type": "object"
}

RealizedLogicalSwitch (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedLogicalSwitch", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "logical_switch_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the logical switch", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "transport_zone_id": {
      "readonly": true, 
      "required": false, 
      "title": "Transport zone identifier", 
      "type": "string"
    }
  }, 
  "title": "Realized Logical Switch", 
  "type": "object"
}

RealizedMACSet (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedMACSet", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized MACSet", 
  "type": "object"
}

RealizedMACSetListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RealizedMACSetListRequestParameters", 
  "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 to result of query", 
      "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": "Realized MACSet list request parameters", 
  "type": "object"
}

RealizedMACSetListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedMACSetListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedMACSet"+, 
        "title": "Realized MACSet list result"
      }, 
      "required": false, 
      "title": "Paged Collection of Realized MACSets", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RealizedNSGroup (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "RealizedGroup"+
  }, 
  "id": "RealizedNSGroup", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RealizedNSGroup"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "evaluations": {
      "description": "Reference to the evaluated members of the NSGroup.\n", 
      "items": {
        "$ref": "RealizedNSGroupMemberEvaluation"+
      }, 
      "maxItems": 500, 
      "readonly": true, 
      "required": false, 
      "title": "Evaluated members of NSGroup", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "RealizedNSGroup", 
        "RealizedSecurityGroup"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Network and Security Group", 
  "type": "object"
}

RealizedNSGroupListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RealizedNSGroupListRequestParameters", 
  "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 to result of query", 
      "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": "Realized NSGroup list request parameters", 
  "type": "object"
}

RealizedNSGroupListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedNSGroupListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedNSGroup"+, 
        "title": "NSGroup list results"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Paged Collection of realized NSGroups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RealizedNSGroupMemberEvaluation (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedNSGroupMemberEvaluation", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "logical_ports": {
      "items": {
        "$ref": "RealizedLogicalPort"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "list of logical ports", 
      "type": "array"
    }, 
    "logical_switches": {
      "items": {
        "$ref": "RealizedLogicalSwitch"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "list of logical switches", 
      "type": "array"
    }, 
    "member_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of the members added to this NSGroup", 
      "type": "integer"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "virtual_machines": {
      "items": {
        "$ref": "RealizedVirtualMachine"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "list of virtual machines", 
      "type": "array"
    }
  }, 
  "title": "Realized NSGroup member evaluation", 
  "type": "object"
}

RealizedNSService (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "RealizedService"+
  }, 
  "id": "RealizedNSService", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RealizedNSService"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "RealizedNSService"
      ], 
      "required": true, 
      "title": "Realized services", 
      "type": "string"
    }, 
    "service_type": {
      "enum": [
        "SERVICE", 
        "SERVICE_GROUP"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Realized nsservice type", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized NSService", 
  "type": "object"
}

RealizedNSServiceListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RealizedNSServiceListRequestParameters", 
  "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 to result of query", 
      "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": "Realized nsservice list request parameters", 
  "type": "object"
}

RealizedNSServiceListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedNSServiceListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedNSService"+, 
        "title": "Realized nsservice list results"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Paged Collection of realized services", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RealizedSecurityGroup (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "RealizedGroup"+
  }, 
  "id": "RealizedSecurityGroup", 
  "polymorphic-type-descriptor": {
    "type-identifier": "RealizedSecurityGroup"
  }, 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "evaluations": {
      "description": "Reference to the evaluted members of the Security Group.\n", 
      "items": {
        "$ref": "RealizedSecurityGroupMemberEvaluation"+
      }, 
      "maxItems": 500, 
      "readonly": true, 
      "required": false, 
      "title": "Evaluated members of Security Group", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "RealizedNSGroup", 
        "RealizedSecurityGroup"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Network and Security Group", 
  "type": "object"
}

RealizedSecurityGroupListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "RealizedSecurityGroupListRequestParameters", 
  "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 to result of query", 
      "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": "Realized Security Group list request parameters", 
  "type": "object"
}

RealizedSecurityGroupListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "RealizedSecurityGroupListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "RealizedSecurityGroup"+, 
        "title": "Security Group list results"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Paged Collection of realized Security Groups", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

RealizedSecurityGroupMemberEvaluation (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedSecurityGroupMemberEvaluation", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "member_count": {
      "readonly": true, 
      "required": false, 
      "title": "Count of the members added to this Security Group", 
      "type": "integer"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "virtual_machines": {
      "items": {
        "$ref": "RealizedVirtualMachine"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "list of virtual machines", 
      "type": "array"
    }
  }, 
  "title": "Realized Security Group member evaluation", 
  "type": "object"
}

RealizedService (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedService", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "RealizedNSService"
      ], 
      "required": true, 
      "title": "Realized services", 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Service", 
  "type": "object"
}

RealizedServices (type)

{
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedServices", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "realized_services": {
      "items": {
        "$ref": "RealizedService"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "List of realized services", 
      "type": "array"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized services", 
  "type": "object"
}

RealizedState (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedState", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "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"
    }, 
    "enforcement_points": {
      "items": {
        "$ref": "RealizedEnforcementPoint"+
      }, 
      "required": false, 
      "title": "Enforcement points for realized policy", 
      "type": "array"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Root of realized policy state", 
  "type": "object"
}

RealizedVirtualMachine (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyRealizedResource"+
  }, 
  "id": "RealizedVirtualMachine", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "alarms": {
      "items": {
        "$ref": "PolicyAlarmResource"+
      }, 
      "required": false, 
      "title": "Alarm info detail", 
      "type": "array"
    }, 
    "compute_ids": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "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"
    }, 
    "host_id": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the host on which the vm exists.", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "intent_reference": {
      "items": {
        "type": "string"
      }, 
      "required": false, 
      "title": "Desire state paths of this object", 
      "type": "array"
    }, 
    "local_id_on_host": {
      "readonly": true, 
      "required": false, 
      "title": "Id of the vm unique within the host.", 
      "type": "string"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "power_state": {
      "enum": [
        "VM_RUNNING", 
        "VM_STOPPED", 
        "VM_SUSPENDED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Current power state of this virtual machine in the system.", 
      "type": "string"
    }, 
    "realization_specific_identifier": {
      "required": false, 
      "title": "Realization id of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "state": {
      "enum": [
        "UNAVAILABLE", 
        "UNREALIZED", 
        "REALIZED", 
        "ERROR"
      ], 
      "required": true, 
      "title": "Realization state of this object", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Realized Virtual Machine", 
  "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"
}

RemoteFilestoreBackupFile (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "BackupFile"+
  }, 
  "id": "RemoteFilestoreBackupFile", 
  "properties": {
    "file_store": {
      "enum": [
        "remote"
      ], 
      "required": true, 
      "title": "File location", 
      "type": "string"
    }, 
    "passphrase": {
      "required": true, 
      "sensitive": true, 
      "title": "Passphrase used to encrypt backup file", 
      "type": "string"
    }, 
    "port": {
      "maximum": 65535, 
      "minimum": 1, 
      "title": "Server port", 
      "type": "integer"
    }, 
    "protocol": {
      "required": true, 
      "title": "Protocol to use to copy file", 
      "type": [
        {
          "$ref": "ScpProtocol"+
        }, 
        {
          "$ref": "SftpProtocol"+
        }
      ]
    }, 
    "server": {
      "pattern": "^[^/:]+$", 
      "required": true, 
      "title": "Remote server hostname or IP address", 
      "type": "string"
    }, 
    "uri": {
      "required": true, 
      "title": "URI of file to copy", 
      "type": "string"
    }
  }, 
  "title": "Remote file store backup file properties", 
  "type": "object"
}

ReorderRequest (type)

{
  "additionalProperties": false, 
  "id": "ReorderRequest", 
  "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", 
  "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 to result of query", 
      "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"
}

Resource (type)

{
  "abstract": true, 
  "id": "Resource", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }
  }, 
  "type": "object"
}

ResourceLink (type)

{
  "additionalProperties": false, 
  "id": "ResourceLink", 
  "properties": {
    "action": {
      "readonly": true, 
      "title": "Optional action", 
      "type": "string"
    }, 
    "href": {
      "readonly": true, 
      "required": true, 
      "type": "string"
    }, 
    "rel": {
      "description": "Custom relation type (follows RFC 5988 where appropriate definitions exist)", 
      "readonly": true, 
      "required": true, 
      "title": "Link relation type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

ResourceReference (type)

{
  "description": "A weak reference to an NSX resource.", 
  "id": "ResourceReference", 
  "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"
}

RestoreProperties (type)

{
  "additionalProperties": false, 
  "id": "RestoreProperties", 
  "properties": {
    "restore_file": {
      "required": true, 
      "title": "Restore file", 
      "type": [
        {
          "$ref": "LocalFilestoreBackupFile"+
        }, 
        {
          "$ref": "RemoteFilestoreBackupFile"+
        }
      ]
    }
  }, 
  "title": "Restore properties", 
  "type": "object"
}

RestoreStep (type)

{
  "id": "RestoreStep", 
  "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"
    }
  }, 
  "type": "object"
}

RevisionedResource (type)

{
  "abstract": true, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "RevisionedResource", 
  "properties": {
    "_links": {
      "description": "The server will populate 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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }
  }, 
  "type": "object"
}

ScpProtocol (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol"+
  }, 
  "id": "ScpProtocol", 
  "properties": {
    "authentication_scheme": {
      "required": true, 
      "title": "Scheme to authenticate if required", 
      "type": [
        {
          "$ref": "PasswordAuthenticationScheme"+
        }
      ]
    }, 
    "name": {
      "enum": [
        "scp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

SecurityCertificate (type)

{
  "additionalProperties": false, 
  "id": "SecurityCertificate", 
  "properties": {
    "pem_encoded": {
      "description": "The certificate must include the enclosing \"-----BEGIN CERTIFICATE-----\" and \"-----END CERTIFICATE-----\"", 
      "display": {
        "order": 1
      }, 
      "minLength": 52, 
      "readonly": false, 
      "required": true, 
      "title": "PEM encoded X.509 certificate", 
      "type": "string"
    }, 
    "ssh_public_key": {
      "display": {
        "order": 4
      }, 
      "readonly": true, 
      "type": "string"
    }, 
    "text": {
      "display": {
        "order": 5
      }, 
      "minLength": 52, 
      "readonly": true, 
      "title": "X.509 certificate in text form", 
      "type": "string"
    }, 
    "valid_from": {
      "display": {
        "order": 2
      }, 
      "readonly": true, 
      "title": "The time when the certificate starts being valid", 
      "type": "string"
    }, 
    "valid_to": {
      "display": {
        "order": 3
      }, 
      "readonly": true, 
      "title": "The time when the certificate stops being valid", 
      "type": "string"
    }
  }, 
  "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", 
  "properties": {
    "action": {
      "readonly": true, 
      "title": "Optional action", 
      "type": "string"
    }, 
    "href": {
      "readonly": true, 
      "required": true, 
      "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"
}

Service (type)

{
  "description": "Used while defining a CommunicationProfileEntry. A service may have multiple\nservice entries.\n", 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "Service", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "service_entries": {
      "items": {
        "$ref": "ServiceEntry"+
      }, 
      "required": true, 
      "title": "Service type", 
      "type": "array"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Contains the information related to a service", 
  "type": "object"
}

ServiceEntry (type)

{
  "abstract": true, 
  "experimental": true, 
  "extends": {
    "$ref": "PolicyConfigResource"+
  }, 
  "id": "ServiceEntry", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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"
    }, 
    "path": {
      "description": "Absolute path of this object", 
      "readonly": true, 
      "required": false, 
      "title": "Absolute path of this object", 
      "type": "string"
    }, 
    "relative_path": {
      "description": "Path relative from its parent", 
      "readonly": true, 
      "required": false, 
      "title": "Relative path of this object", 
      "type": "string"
    }, 
    "resource_type": {
      "enum": [
        "EtherTypeServiceEntry", 
        "IPProtocolServiceEntry", 
        "IGMPTypeServiceEntry", 
        "ICMPTypeServiceEntry", 
        "ALGTypeServiceEntry", 
        "L4PortSetServiceEntry"
      ], 
      "required": true, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag"+
      }, 
      "maxItems": 15, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "An Service entry that describes traffic", 
  "type": "object"
}

ServiceEntryListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ServiceEntryListRequestParameters", 
  "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 to result of query", 
      "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 entry list request parameters", 
  "type": "object"
}

ServiceEntryListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceEntryListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "ServiceEntry"+
      }, 
      "required": true, 
      "title": "Service entry list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Service entries", 
  "type": "object"
}

ServiceListRequestParameters (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListRequestParameters"+
  }, 
  "id": "ServiceListRequestParameters", 
  "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 to result of query", 
      "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 list request parameters", 
  "type": "object"
}

ServiceListResult (type)

{
  "additionalProperties": false, 
  "experimental": true, 
  "extends": {
    "$ref": "ListResult"+
  }, 
  "id": "ServiceListResult", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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": "Service"+
      }, 
      "required": true, 
      "title": "Service list results", 
      "type": "array"
    }, 
    "sort_ascending": {
      "readonly": true, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Paged Collection of Services", 
  "type": "object"
}

SftpProtocol (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Protocol"+
  }, 
  "id": "SftpProtocol", 
  "properties": {
    "authentication_scheme": {
      "required": true, 
      "title": "Scheme to authenticate if required", 
      "type": [
        {
          "$ref": "PasswordAuthenticationScheme"+
        }
      ]
    }, 
    "name": {
      "enum": [
        "sftp"
      ], 
      "required": true, 
      "title": "Protocol name", 
      "type": "string"
    }, 
    "ssh_fingerprint": {
      "required": true, 
      "title": "SSH fingerprint of server", 
      "type": "string"
    }
  }, 
  "type": "object"
}

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"
}

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, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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"
}

StatusSummaryRequestParameters (type)

{
  "additionalProperties": false, 
  "id": "StatusSummaryRequestParameters", 
  "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"
    }
  }, 
  "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", 
  "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"
}

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", 
  "properties": {
    "scope": {
      "default": "", 
      "description": "Tag searches may optionally be restricted by scope", 
      "display": {
        "order": 1
      }, 
      "maxLength": 20, 
      "readonly": false, 
      "title": "Tag scope", 
      "type": "string"
    }, 
    "tag": {
      "default": "", 
      "description": "Identifier meaningful to user", 
      "display": {
        "order": 2
      }, 
      "maxLength": 40, 
      "readonly": false, 
      "title": "Tag value", 
      "type": "string"
    }
  }, 
  "type": "object"
}

TaskProperties (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "TaskProperties", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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"
}

TaskStatus (type)

{
  "enum": [
    "running", 
    "error", 
    "success", 
    "canceling", 
    "canceled", 
    "killed"
  ], 
  "id": "TaskStatus", 
  "title": "Current status of the task", 
  "type": "string"
}

TimeDuration (type)

{
  "id": "TimeDuration", 
  "title": "Time duration in milliseconds", 
  "type": "integer"
}

Timezone (type)

{
  "additionalProperties": false, 
  "id": "Timezone", 
  "properties": {
    "tzname": {
      "maxLength": 40, 
      "title": "Standard abbreviation of timezone", 
      "type": "string"
    }
  }, 
  "title": "Timezone of system", 
  "type": "object"
}

UnboundedKeyValuePair (type)

{
  "additionalProperties": false, 
  "id": "UnboundedKeyValuePair", 
  "properties": {
    "key": {
      "readonly": false, 
      "required": true, 
      "title": "Key", 
      "type": "string"
    }, 
    "value": {
      "readonly": false, 
      "required": true, 
      "title": "Value", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpdatePolicyUIPreferencesRequestParams (type)

{
  "additionalProperties": false, 
  "id": "UpdatePolicyUIPreferencesRequestParams", 
  "properties": {
    "path": {
      "required": true, 
      "title": "Specifies the entity for which the UI preferences have\nto be updated.\n", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeBundle (type)

{
  "additionalProperties": false, 
  "id": "UpgradeBundle", 
  "properties": {
    "file": {
      "readonly": false, 
      "required": true, 
      "title": "Upgrade bundle file", 
      "type": "multipart_file"
    }
  }, 
  "type": "object"
}

UpgradeHistory (type)

{
  "additionalProperties": false, 
  "id": "UpgradeHistory", 
  "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradePlanResetRequest (type)

{
  "additionalProperties": false, 
  "id": "UpgradePlanResetRequest", 
  "properties": {
    "component_type": {
      "readonly": false, 
      "required": true, 
      "title": "Component type", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradePlanSettings (type)

{
  "additionalProperties": false, 
  "id": "UpgradePlanSettings", 
  "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", 
  "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", 
  "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_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"
}

UpgradeTaskProperties (type)

{
  "additionalProperties": false, 
  "id": "UpgradeTaskProperties", 
  "properties": {
    "action_name": {
      "required": false, 
      "title": "helper for the task", 
      "type": "string"
    }, 
    "bundle_name": {
      "required": true, 
      "title": "Name of Bundle", 
      "type": "string"
    }, 
    "parameters": {
      "items": {
        "$ref": "KeyValuePair"+
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Bundle arguments", 
      "type": "array"
    }
  }, 
  "title": "Task properties", 
  "type": "object"
}

UpgradeUnit (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "Resource"+
  }, 
  "id": "UpgradeUnit", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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", 
  "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 to result of query", 
      "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "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", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": 15, 
      "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", 
  "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": "integer"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "_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": 15, 
      "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupInfo (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitGroupInfo", 
  "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", 
  "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 to result of query", 
      "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitGroupStatus (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitGroupStatus", 
  "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitList (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitList", 
  "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", 
  "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 to result of query", 
      "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitStatus (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitStatus", 
  "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", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink"+
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink"+, 
      "readonly": true
    }, 
    "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, 
      "type": "boolean"
    }, 
    "sort_by": {
      "readonly": true, 
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}

UpgradeUnitTypeStats (type)

{
  "additionalProperties": false, 
  "id": "UpgradeUnitTypeStats", 
  "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", 
  "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", 
  "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 to result of query", 
      "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"
}

UsernamePasswordLoginCredential (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LoginCredential"+
  }, 
  "id": "UsernamePasswordLoginCredential", 
  "polymorphic-type-descriptor": {
    "type-identifier": "UsernamePasswordLoginCredential"
  }, 
  "properties": {
    "credential_type": {
      "help_summary": "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"
    }
  }, 
  "type": "object"
}

VerifiableAsymmetricLoginCredential (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "LoginCredential"+
  }, 
  "id": "VerifiableAsymmetricLoginCredential", 
  "polymorphic-type-descriptor": {
    "type-identifier": "VerifiableAsymmetricLoginCredential"
  }, 
  "properties": {
    "asymmetric_credential": {
      "required": false, 
      "title": "Asymmetric login credential", 
      "type": "string"
    }, 
    "credential_key": {
      "required": false, 
      "title": "Credential key", 
      "type": "string"
    }, 
    "credential_type": {
      "help_summary": "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, 
      "title": "Credential verifier", 
      "type": "string"
    }
  }, 
  "type": "object"
}

VlanID (type)

{
  "id": "VlanID", 
  "maximum": 4094, 
  "minimum": 0, 
  "type": "integer"
}


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.

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.